2026/04/17 - Amazon QuickSight - 22 updated api methods
Changes Public release of dashboard customization summary, S3 Tables data source type, Athena cross-account connector, custom sorting for controls, and AI-powered analysis generation.
{'Definition': {'FilterGroups': {'Filters': {'CategoryFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'NestedFilter': {'InnerFilter': {'CategoryInnerFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}}}},
'NumericEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'NumericRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'RelativeDatesFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'TimeEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'TimeRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'TopBottomFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}}}},
'Sheets': {'FilterControls': {'Dropdown': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'List': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}},
'ParameterControls': {'Dropdown': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'List': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}}}
Creates an analysis in Amazon Quick Sight. 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.
{'Capabilities': {'GenerateAnalyses': 'DENY'}}
Creates a custom permissions profile.
See also: AWS API Documentation
Request Syntax
client.create_custom_permissions(
AwsAccountId='string',
CustomPermissionsName='string',
Capabilities={
'ExportToCsv': 'DENY',
'ExportToExcel': 'DENY',
'ExportToPdf': 'DENY',
'PrintReports': 'DENY',
'CreateAndUpdateThemes': 'DENY',
'AddOrRunAnomalyDetectionForAnalyses': 'DENY',
'ShareAnalyses': 'DENY',
'CreateAndUpdateDatasets': 'DENY',
'ShareDatasets': 'DENY',
'SubscribeDashboardEmailReports': 'DENY',
'CreateAndUpdateDashboardEmailReports': 'DENY',
'ShareDashboards': 'DENY',
'CreateAndUpdateThresholdAlerts': 'DENY',
'RenameSharedFolders': 'DENY',
'CreateSharedFolders': 'DENY',
'CreateAndUpdateDataSources': 'DENY',
'ShareDataSources': 'DENY',
'ViewAccountSPICECapacity': 'DENY',
'CreateSPICEDataset': 'DENY',
'ExportToPdfInScheduledReports': 'DENY',
'ExportToCsvInScheduledReports': 'DENY',
'ExportToExcelInScheduledReports': 'DENY',
'IncludeContentInScheduledReportsEmail': 'DENY',
'Dashboard': 'DENY',
'Analysis': 'DENY',
'Automate': 'DENY',
'Flow': 'DENY',
'PublishWithoutApproval': 'DENY',
'UseBedrockModels': 'DENY',
'PerformFlowUiTask': 'DENY',
'ApproveFlowShareRequests': 'DENY',
'UseAgentWebSearch': 'DENY',
'KnowledgeBase': 'DENY',
'Action': 'DENY',
'GenericHTTPAction': 'DENY',
'CreateAndUpdateGenericHTTPAction': 'DENY',
'ShareGenericHTTPAction': 'DENY',
'UseGenericHTTPAction': 'DENY',
'AsanaAction': 'DENY',
'CreateAndUpdateAsanaAction': 'DENY',
'ShareAsanaAction': 'DENY',
'UseAsanaAction': 'DENY',
'SlackAction': 'DENY',
'CreateAndUpdateSlackAction': 'DENY',
'ShareSlackAction': 'DENY',
'UseSlackAction': 'DENY',
'ServiceNowAction': 'DENY',
'CreateAndUpdateServiceNowAction': 'DENY',
'ShareServiceNowAction': 'DENY',
'UseServiceNowAction': 'DENY',
'SalesforceAction': 'DENY',
'CreateAndUpdateSalesforceAction': 'DENY',
'ShareSalesforceAction': 'DENY',
'UseSalesforceAction': 'DENY',
'MSExchangeAction': 'DENY',
'CreateAndUpdateMSExchangeAction': 'DENY',
'ShareMSExchangeAction': 'DENY',
'UseMSExchangeAction': 'DENY',
'PagerDutyAction': 'DENY',
'CreateAndUpdatePagerDutyAction': 'DENY',
'SharePagerDutyAction': 'DENY',
'UsePagerDutyAction': 'DENY',
'JiraAction': 'DENY',
'CreateAndUpdateJiraAction': 'DENY',
'ShareJiraAction': 'DENY',
'UseJiraAction': 'DENY',
'ConfluenceAction': 'DENY',
'CreateAndUpdateConfluenceAction': 'DENY',
'ShareConfluenceAction': 'DENY',
'UseConfluenceAction': 'DENY',
'OneDriveAction': 'DENY',
'CreateAndUpdateOneDriveAction': 'DENY',
'ShareOneDriveAction': 'DENY',
'UseOneDriveAction': 'DENY',
'SharePointAction': 'DENY',
'CreateAndUpdateSharePointAction': 'DENY',
'ShareSharePointAction': 'DENY',
'UseSharePointAction': 'DENY',
'MSTeamsAction': 'DENY',
'CreateAndUpdateMSTeamsAction': 'DENY',
'ShareMSTeamsAction': 'DENY',
'UseMSTeamsAction': 'DENY',
'GoogleCalendarAction': 'DENY',
'CreateAndUpdateGoogleCalendarAction': 'DENY',
'ShareGoogleCalendarAction': 'DENY',
'UseGoogleCalendarAction': 'DENY',
'ZendeskAction': 'DENY',
'CreateAndUpdateZendeskAction': 'DENY',
'ShareZendeskAction': 'DENY',
'UseZendeskAction': 'DENY',
'SmartsheetAction': 'DENY',
'CreateAndUpdateSmartsheetAction': 'DENY',
'ShareSmartsheetAction': 'DENY',
'UseSmartsheetAction': 'DENY',
'SAPBusinessPartnerAction': 'DENY',
'CreateAndUpdateSAPBusinessPartnerAction': 'DENY',
'ShareSAPBusinessPartnerAction': 'DENY',
'UseSAPBusinessPartnerAction': 'DENY',
'SAPProductMasterDataAction': 'DENY',
'CreateAndUpdateSAPProductMasterDataAction': 'DENY',
'ShareSAPProductMasterDataAction': 'DENY',
'UseSAPProductMasterDataAction': 'DENY',
'SAPPhysicalInventoryAction': 'DENY',
'CreateAndUpdateSAPPhysicalInventoryAction': 'DENY',
'ShareSAPPhysicalInventoryAction': 'DENY',
'UseSAPPhysicalInventoryAction': 'DENY',
'SAPBillOfMaterialAction': 'DENY',
'CreateAndUpdateSAPBillOfMaterialAction': 'DENY',
'ShareSAPBillOfMaterialAction': 'DENY',
'UseSAPBillOfMaterialAction': 'DENY',
'SAPMaterialStockAction': 'DENY',
'CreateAndUpdateSAPMaterialStockAction': 'DENY',
'ShareSAPMaterialStockAction': 'DENY',
'UseSAPMaterialStockAction': 'DENY',
'FactSetAction': 'DENY',
'CreateAndUpdateFactSetAction': 'DENY',
'ShareFactSetAction': 'DENY',
'UseFactSetAction': 'DENY',
'AmazonSThreeAction': 'DENY',
'CreateAndUpdateAmazonSThreeAction': 'DENY',
'ShareAmazonSThreeAction': 'DENY',
'UseAmazonSThreeAction': 'DENY',
'TextractAction': 'DENY',
'CreateAndUpdateTextractAction': 'DENY',
'ShareTextractAction': 'DENY',
'UseTextractAction': 'DENY',
'ComprehendAction': 'DENY',
'CreateAndUpdateComprehendAction': 'DENY',
'ShareComprehendAction': 'DENY',
'UseComprehendAction': 'DENY',
'ComprehendMedicalAction': 'DENY',
'CreateAndUpdateComprehendMedicalAction': 'DENY',
'ShareComprehendMedicalAction': 'DENY',
'UseComprehendMedicalAction': 'DENY',
'AmazonBedrockARSAction': 'DENY',
'CreateAndUpdateAmazonBedrockARSAction': 'DENY',
'ShareAmazonBedrockARSAction': 'DENY',
'UseAmazonBedrockARSAction': 'DENY',
'AmazonBedrockFSAction': 'DENY',
'CreateAndUpdateAmazonBedrockFSAction': 'DENY',
'ShareAmazonBedrockFSAction': 'DENY',
'UseAmazonBedrockFSAction': 'DENY',
'AmazonBedrockKRSAction': 'DENY',
'CreateAndUpdateAmazonBedrockKRSAction': 'DENY',
'ShareAmazonBedrockKRSAction': 'DENY',
'UseAmazonBedrockKRSAction': 'DENY',
'MCPAction': 'DENY',
'CreateAndUpdateMCPAction': 'DENY',
'ShareMCPAction': 'DENY',
'UseMCPAction': 'DENY',
'OpenAPIAction': 'DENY',
'CreateAndUpdateOpenAPIAction': 'DENY',
'ShareOpenAPIAction': 'DENY',
'UseOpenAPIAction': 'DENY',
'SandPGMIAction': 'DENY',
'CreateAndUpdateSandPGMIAction': 'DENY',
'ShareSandPGMIAction': 'DENY',
'UseSandPGMIAction': 'DENY',
'SandPGlobalEnergyAction': 'DENY',
'CreateAndUpdateSandPGlobalEnergyAction': 'DENY',
'ShareSandPGlobalEnergyAction': 'DENY',
'UseSandPGlobalEnergyAction': 'DENY',
'BambooHRAction': 'DENY',
'CreateAndUpdateBambooHRAction': 'DENY',
'ShareBambooHRAction': 'DENY',
'UseBambooHRAction': 'DENY',
'BoxAgentAction': 'DENY',
'CreateAndUpdateBoxAgentAction': 'DENY',
'ShareBoxAgentAction': 'DENY',
'UseBoxAgentAction': 'DENY',
'CanvaAgentAction': 'DENY',
'CreateAndUpdateCanvaAgentAction': 'DENY',
'ShareCanvaAgentAction': 'DENY',
'UseCanvaAgentAction': 'DENY',
'GithubAction': 'DENY',
'CreateAndUpdateGithubAction': 'DENY',
'ShareGithubAction': 'DENY',
'UseGithubAction': 'DENY',
'NotionAction': 'DENY',
'CreateAndUpdateNotionAction': 'DENY',
'ShareNotionAction': 'DENY',
'UseNotionAction': 'DENY',
'LinearAction': 'DENY',
'CreateAndUpdateLinearAction': 'DENY',
'ShareLinearAction': 'DENY',
'UseLinearAction': 'DENY',
'HuggingFaceAction': 'DENY',
'CreateAndUpdateHuggingFaceAction': 'DENY',
'ShareHuggingFaceAction': 'DENY',
'UseHuggingFaceAction': 'DENY',
'MondayAction': 'DENY',
'CreateAndUpdateMondayAction': 'DENY',
'ShareMondayAction': 'DENY',
'UseMondayAction': 'DENY',
'HubspotAction': 'DENY',
'CreateAndUpdateHubspotAction': 'DENY',
'ShareHubspotAction': 'DENY',
'UseHubspotAction': 'DENY',
'IntercomAction': 'DENY',
'CreateAndUpdateIntercomAction': 'DENY',
'ShareIntercomAction': 'DENY',
'UseIntercomAction': 'DENY',
'NewRelicAction': 'DENY',
'CreateAndUpdateNewRelicAction': 'DENY',
'ShareNewRelicAction': 'DENY',
'UseNewRelicAction': 'DENY',
'Topic': 'DENY',
'EditVisualWithQ': 'DENY',
'BuildCalculatedFieldWithQ': 'DENY',
'CreateDashboardExecutiveSummaryWithQ': 'DENY',
'Space': 'DENY',
'CreateSpaces': 'DENY',
'ShareSpaces': 'DENY',
'ChatAgent': 'DENY',
'CreateChatAgents': 'DENY',
'ShareChatAgents': 'DENY',
'Research': 'DENY',
'SelfUpgradeUserRole': 'DENY',
'Extension': 'DENY',
'ManageSharedFolders': 'DENY',
'GenerateAnalyses': 'DENY'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The ID of the Amazon Web Services account that you want to create the custom permissions profile in.
string
[REQUIRED]
The name of the custom permissions profile that you want to create.
dict
A set of actions to include in the custom permissions profile.
ExportToCsv (string) --
The ability to export to CSV files from the UI.
ExportToExcel (string) --
The ability to export to Excel files from the UI.
ExportToPdf (string) --
The ability to export to PDF files from the UI.
PrintReports (string) --
The ability to print reports.
CreateAndUpdateThemes (string) --
The ability to export to Create and Update themes.
AddOrRunAnomalyDetectionForAnalyses (string) --
The ability to add or run anomaly detection.
ShareAnalyses (string) --
The ability to share analyses.
CreateAndUpdateDatasets (string) --
The ability to create and update datasets.
ShareDatasets (string) --
The ability to share datasets.
SubscribeDashboardEmailReports (string) --
The ability to subscribe to email reports.
CreateAndUpdateDashboardEmailReports (string) --
The ability to create and update email reports.
ShareDashboards (string) --
The ability to share dashboards.
CreateAndUpdateThresholdAlerts (string) --
The ability to create and update threshold alerts.
RenameSharedFolders (string) --
The ability to rename shared folders.
CreateSharedFolders (string) --
The ability to create shared folders.
CreateAndUpdateDataSources (string) --
The ability to create and update data sources.
ShareDataSources (string) --
The ability to share data sources.
ViewAccountSPICECapacity (string) --
The ability to view account SPICE capacity.
CreateSPICEDataset (string) --
The ability to create a SPICE dataset.
ExportToPdfInScheduledReports (string) --
The ability to export to PDF files in scheduled email reports.
ExportToCsvInScheduledReports (string) --
The ability to export to CSV files in scheduled email reports.
ExportToExcelInScheduledReports (string) --
The ability to export to Excel files in scheduled email reports.
IncludeContentInScheduledReportsEmail (string) --
The ability to include content in scheduled email reports.
Dashboard (string) --
The ability to perform dashboard-related actions.
Analysis (string) --
The ability to perform analysis-related actions.
Automate (string) --
The ability to perform automate-related actions.
Flow (string) --
The ability to perform flow-related actions.
PublishWithoutApproval (string) --
The ability to enable approvals for flow share.
UseBedrockModels (string) --
The ability to use Bedrock models for general knowledge step in flows.
PerformFlowUiTask (string) --
The ability to use UI Agent step to perform tasks on public websites.
ApproveFlowShareRequests (string) --
The ability to review and approve sharing requests of Flows.
UseAgentWebSearch (string) --
The ability to use internet to enhance results in Chat Agents, Flows, and Quick Research. Web search queries will be processed securely in an Amazon Web Services region us-east-1.
KnowledgeBase (string) --
The ability to use knowledge bases to specify content from external applications.
Action (string) --
The ability to perform actions in external services through Action connectors. Actions allow users to interact with third-party systems.
GenericHTTPAction (string) --
The ability to perform actions using REST API connection connectors.
CreateAndUpdateGenericHTTPAction (string) --
The ability to create and update REST API connection actions.
ShareGenericHTTPAction (string) --
The ability to share REST API connection actions.
UseGenericHTTPAction (string) --
The ability to use REST API connection actions.
AsanaAction (string) --
The ability to perform actions using Asana connectors.
CreateAndUpdateAsanaAction (string) --
The ability to create and update Asana actions.
ShareAsanaAction (string) --
The ability to share Asana actions.
UseAsanaAction (string) --
The ability to use Asana actions.
SlackAction (string) --
The ability to perform actions using Slack connectors.
CreateAndUpdateSlackAction (string) --
The ability to create and update Slack actions.
ShareSlackAction (string) --
The ability to share Slack actions.
UseSlackAction (string) --
The ability to use Slack actions.
ServiceNowAction (string) --
The ability to perform actions using ServiceNow connectors.
CreateAndUpdateServiceNowAction (string) --
The ability to create and update ServiceNow actions.
ShareServiceNowAction (string) --
The ability to share ServiceNow actions.
UseServiceNowAction (string) --
The ability to use ServiceNow actions.
SalesforceAction (string) --
The ability to perform actions using Salesforce connectors.
CreateAndUpdateSalesforceAction (string) --
The ability to create and update Salesforce actions.
ShareSalesforceAction (string) --
The ability to share Salesforce actions.
UseSalesforceAction (string) --
The ability to use Salesforce actions.
MSExchangeAction (string) --
The ability to perform actions using Microsoft Outlook connectors.
CreateAndUpdateMSExchangeAction (string) --
The ability to create and update Microsoft Outlook actions.
ShareMSExchangeAction (string) --
The ability to share Microsoft Outlook actions.
UseMSExchangeAction (string) --
The ability to use Microsoft Outlook actions.
PagerDutyAction (string) --
The ability to perform actions using PagerDuty Advance connectors.
CreateAndUpdatePagerDutyAction (string) --
The ability to create and update PagerDuty Advance actions.
SharePagerDutyAction (string) --
The ability to share PagerDuty Advance actions.
UsePagerDutyAction (string) --
The ability to use PagerDuty Advance actions.
JiraAction (string) --
The ability to perform actions using Jira connectors.
CreateAndUpdateJiraAction (string) --
The ability to create and update Jira actions.
ShareJiraAction (string) --
The ability to share Jira actions.
UseJiraAction (string) --
The ability to use Jira actions.
ConfluenceAction (string) --
The ability to perform actions using Atlassian Confluence Cloud connectors.
CreateAndUpdateConfluenceAction (string) --
The ability to create and update Atlassian Confluence Cloud actions.
ShareConfluenceAction (string) --
The ability to share Atlassian Confluence Cloud actions.
UseConfluenceAction (string) --
The ability to use Atlassian Confluence Cloud actions.
OneDriveAction (string) --
The ability to perform actions using Microsoft OneDrive connectors.
CreateAndUpdateOneDriveAction (string) --
The ability to create and update Microsoft OneDrive actions.
ShareOneDriveAction (string) --
The ability to share Microsoft OneDrive actions.
UseOneDriveAction (string) --
The ability to use Microsoft OneDrive actions.
SharePointAction (string) --
The ability to perform actions using Microsoft SharePoint Online connectors.
CreateAndUpdateSharePointAction (string) --
The ability to create and update Microsoft SharePoint Online actions.
ShareSharePointAction (string) --
The ability to share Microsoft SharePoint Online actions.
UseSharePointAction (string) --
The ability to use Microsoft SharePoint Online actions.
MSTeamsAction (string) --
The ability to perform actions using Microsoft Teams connectors.
CreateAndUpdateMSTeamsAction (string) --
The ability to create and update Microsoft Teams actions.
ShareMSTeamsAction (string) --
The ability to share Microsoft Teams actions.
UseMSTeamsAction (string) --
The ability to use Microsoft Teams actions.
GoogleCalendarAction (string) --
The ability to perform actions using Google Calendar connectors.
CreateAndUpdateGoogleCalendarAction (string) --
The ability to create and update Google Calendar actions.
ShareGoogleCalendarAction (string) --
The ability to share Google Calendar actions.
UseGoogleCalendarAction (string) --
The ability to use Google Calendar actions.
ZendeskAction (string) --
The ability to perform actions using Zendesk connectors.
CreateAndUpdateZendeskAction (string) --
The ability to create and update Zendesk actions.
ShareZendeskAction (string) --
The ability to share Zendesk actions.
UseZendeskAction (string) --
The ability to use Zendesk actions.
SmartsheetAction (string) --
The ability to perform actions using Smartsheet connectors.
CreateAndUpdateSmartsheetAction (string) --
The ability to create and update Smartsheet actions.
ShareSmartsheetAction (string) --
The ability to share Smartsheet actions.
UseSmartsheetAction (string) --
The ability to use Smartsheet actions.
SAPBusinessPartnerAction (string) --
The ability to perform actions using SAP Business Partner connectors.
CreateAndUpdateSAPBusinessPartnerAction (string) --
The ability to create and update SAP Business Partner actions.
ShareSAPBusinessPartnerAction (string) --
The ability to share SAP Business Partner actions.
UseSAPBusinessPartnerAction (string) --
The ability to use SAP Business Partner actions.
SAPProductMasterDataAction (string) --
The ability to perform actions using SAP Product Master connectors.
CreateAndUpdateSAPProductMasterDataAction (string) --
The ability to create and update SAP Product Master actions.
ShareSAPProductMasterDataAction (string) --
The ability to share SAP Product Master actions.
UseSAPProductMasterDataAction (string) --
The ability to use SAP Product Master actions.
SAPPhysicalInventoryAction (string) --
The ability to perform actions using SAP Physical Inventory connectors.
CreateAndUpdateSAPPhysicalInventoryAction (string) --
The ability to create and update SAP Physical Inventory actions.
ShareSAPPhysicalInventoryAction (string) --
The ability to share SAP Physical Inventory actions.
UseSAPPhysicalInventoryAction (string) --
The ability to use SAP Physical Inventory actions.
SAPBillOfMaterialAction (string) --
The ability to perform actions using SAP Bill of Materials connectors.
CreateAndUpdateSAPBillOfMaterialAction (string) --
The ability to create and update SAP Bill of Materials actions.
ShareSAPBillOfMaterialAction (string) --
The ability to share SAP Bill of Materials actions.
UseSAPBillOfMaterialAction (string) --
The ability to use SAP Bill of Materials actions.
SAPMaterialStockAction (string) --
The ability to perform actions using SAP Material Stock connectors.
CreateAndUpdateSAPMaterialStockAction (string) --
The ability to create and update SAP Material Stock actions.
ShareSAPMaterialStockAction (string) --
The ability to share SAP Material Stock actions.
UseSAPMaterialStockAction (string) --
The ability to use SAP Material Stock actions.
FactSetAction (string) --
The ability to perform actions using FactSet connectors.
CreateAndUpdateFactSetAction (string) --
The ability to create and update FactSet actions.
ShareFactSetAction (string) --
The ability to share FactSet actions.
UseFactSetAction (string) --
The ability to use FactSet actions.
AmazonSThreeAction (string) --
The ability to perform actions using Amazon S3 connectors.
CreateAndUpdateAmazonSThreeAction (string) --
The ability to create and update Amazon S3 actions.
ShareAmazonSThreeAction (string) --
The ability to share Amazon S3 actions.
UseAmazonSThreeAction (string) --
The ability to use Amazon S3 actions.
TextractAction (string) --
The ability to perform actions using Textract connectors.
CreateAndUpdateTextractAction (string) --
The ability to create and update Textract actions.
ShareTextractAction (string) --
The ability to share Textract actions.
UseTextractAction (string) --
The ability to use Textract actions.
ComprehendAction (string) --
The ability to perform actions using Comprehend connectors.
CreateAndUpdateComprehendAction (string) --
The ability to create and update Comprehend actions.
ShareComprehendAction (string) --
The ability to share Comprehend actions.
UseComprehendAction (string) --
The ability to use Comprehend actions.
ComprehendMedicalAction (string) --
The ability to perform actions using Comprehend Medical connectors.
CreateAndUpdateComprehendMedicalAction (string) --
The ability to create and update Comprehend Medical actions.
ShareComprehendMedicalAction (string) --
The ability to share Comprehend Medical actions.
UseComprehendMedicalAction (string) --
The ability to use Comprehend Medical actions.
AmazonBedrockARSAction (string) --
The ability to perform actions using Bedrock Agent connectors.
CreateAndUpdateAmazonBedrockARSAction (string) --
The ability to create and update Bedrock Agent actions.
ShareAmazonBedrockARSAction (string) --
The ability to share Bedrock Agent actions.
UseAmazonBedrockARSAction (string) --
The ability to use Bedrock Agent actions.
AmazonBedrockFSAction (string) --
The ability to perform actions using Bedrock Runtime connectors.
CreateAndUpdateAmazonBedrockFSAction (string) --
The ability to create and update Bedrock Runtime actions.
ShareAmazonBedrockFSAction (string) --
The ability to share Bedrock Runtime actions.
UseAmazonBedrockFSAction (string) --
The ability to use Bedrock Runtime actions.
AmazonBedrockKRSAction (string) --
The ability to perform actions using Bedrock Data Automation Runtime connectors.
CreateAndUpdateAmazonBedrockKRSAction (string) --
The ability to create and update Bedrock Data Automation Runtime actions.
ShareAmazonBedrockKRSAction (string) --
The ability to share Bedrock Data Automation Runtime actions.
UseAmazonBedrockKRSAction (string) --
The ability to use Bedrock Data Automation Runtime actions.
MCPAction (string) --
The ability to perform actions using Model Context Protocol connectors.
CreateAndUpdateMCPAction (string) --
The ability to create and update Model Context Protocol actions.
ShareMCPAction (string) --
The ability to share Model Context Protocol actions.
UseMCPAction (string) --
The ability to use Model Context Protocol actions.
OpenAPIAction (string) --
The ability to perform actions using OpenAPI Specification connectors.
CreateAndUpdateOpenAPIAction (string) --
The ability to create and update OpenAPI Specification actions.
ShareOpenAPIAction (string) --
The ability to share OpenAPI Specification actions.
UseOpenAPIAction (string) --
The ability to use OpenAPI Specification actions.
SandPGMIAction (string) --
The ability to perform actions using S&P Global Market Intelligence connectors.
CreateAndUpdateSandPGMIAction (string) --
The ability to create and update S&P Global Market Intelligence actions.
ShareSandPGMIAction (string) --
The ability to share S&P Global Market Intelligence actions.
UseSandPGMIAction (string) --
The ability to use S&P Global Market Intelligence actions.
SandPGlobalEnergyAction (string) --
The ability to perform actions using S&P Global Energy connectors.
CreateAndUpdateSandPGlobalEnergyAction (string) --
The ability to create and update S&P Global Energy actions.
ShareSandPGlobalEnergyAction (string) --
The ability to share S&P Global Energy actions.
UseSandPGlobalEnergyAction (string) --
The ability to use S&P Global Energy actions.
BambooHRAction (string) --
The ability to perform actions using BambooHR connectors.
CreateAndUpdateBambooHRAction (string) --
The ability to create and update BambooHR actions.
ShareBambooHRAction (string) --
The ability to share BambooHR actions.
UseBambooHRAction (string) --
The ability to use BambooHR actions.
BoxAgentAction (string) --
The ability to perform actions using Box Agent connectors.
CreateAndUpdateBoxAgentAction (string) --
The ability to create and update Box Agent actions.
ShareBoxAgentAction (string) --
The ability to share Box Agent actions.
UseBoxAgentAction (string) --
The ability to use Box Agent actions.
CanvaAgentAction (string) --
The ability to perform actions using Canva Agent connectors.
CreateAndUpdateCanvaAgentAction (string) --
The ability to create and update Canva Agent actions.
ShareCanvaAgentAction (string) --
The ability to share Canva Agent actions.
UseCanvaAgentAction (string) --
The ability to use Canva Agent actions.
GithubAction (string) --
The ability to perform actions using GitHub connectors.
CreateAndUpdateGithubAction (string) --
The ability to create and update GitHub actions.
ShareGithubAction (string) --
The ability to share GitHub actions.
UseGithubAction (string) --
The ability to use GitHub actions.
NotionAction (string) --
The ability to perform actions using Notion connectors.
CreateAndUpdateNotionAction (string) --
The ability to create and update Notion actions.
ShareNotionAction (string) --
The ability to share Notion actions.
UseNotionAction (string) --
The ability to use Notion actions.
LinearAction (string) --
The ability to perform actions using Linear connectors.
CreateAndUpdateLinearAction (string) --
The ability to create and update Linear actions.
ShareLinearAction (string) --
The ability to share Linear actions.
UseLinearAction (string) --
The ability to use Linear actions.
HuggingFaceAction (string) --
The ability to perform actions using HuggingFace connectors.
CreateAndUpdateHuggingFaceAction (string) --
The ability to create and update HuggingFace actions.
ShareHuggingFaceAction (string) --
The ability to share HuggingFace actions.
UseHuggingFaceAction (string) --
The ability to use HuggingFace actions.
MondayAction (string) --
The ability to perform actions using Monday connectors.
CreateAndUpdateMondayAction (string) --
The ability to create and update Monday actions.
ShareMondayAction (string) --
The ability to share Monday actions.
UseMondayAction (string) --
The ability to use Monday actions.
HubspotAction (string) --
The ability to perform actions using Hubspot connectors.
CreateAndUpdateHubspotAction (string) --
The ability to create and update Hubspot actions.
ShareHubspotAction (string) --
The ability to share Hubspot actions.
UseHubspotAction (string) --
The ability to use Hubspot actions.
IntercomAction (string) --
The ability to perform actions using Intercom connectors.
CreateAndUpdateIntercomAction (string) --
The ability to create and update Intercom actions.
ShareIntercomAction (string) --
The ability to share Intercom actions.
UseIntercomAction (string) --
The ability to use Intercom actions.
NewRelicAction (string) --
The ability to perform actions using New Relic connectors.
CreateAndUpdateNewRelicAction (string) --
The ability to create and update New Relic actions.
ShareNewRelicAction (string) --
The ability to share New Relic actions.
UseNewRelicAction (string) --
The ability to use New Relic actions.
Topic (string) --
The ability to perform Topic-related actions.
EditVisualWithQ (string) --
The ability to Edit Visual with AI
BuildCalculatedFieldWithQ (string) --
The ability to Build Calculation with AI
CreateDashboardExecutiveSummaryWithQ (string) --
The ability to Create Executive Summary
Space (string) --
The ability to perform space-related actions.
CreateSpaces (string) --
The ability to create spaces.
ShareSpaces (string) --
The ability to share spaces with other users and groups.
ChatAgent (string) --
The ability to perform chat-related actions.
CreateChatAgents (string) --
The ability to create chat agents.
ShareChatAgents (string) --
The ability to share chat agents with other users and groups.
Research (string) --
The ability to perform research-related actions.
SelfUpgradeUserRole (string) --
The ability to enable users to upgrade their user role.
Extension (string) --
The ability to perform Extension-related actions.
ManageSharedFolders (string) --
The ability to create, update, delete and view shared folders (both restricted and unrestricted), ability to add any asset to shared folders, and ability to share the folders.
Note: This does not prevent inheriting access to assets that others share with them through folder membership.
GenerateAnalyses (string) --
The ability to generate analysis using AI
list
The tags to associate with the custom permissions profile.
(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
Response Syntax
{
'Status': 123,
'Arn': 'string',
'RequestId': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
Arn (string) --
The Amazon Resource Name (ARN) of the custom permissions profile.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'FilterGroups': {'Filters': {'CategoryFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'NestedFilter': {'InnerFilter': {'CategoryInnerFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}}}},
'NumericEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'NumericRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'RelativeDatesFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'TimeEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'TimeRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'TopBottomFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}}}},
'Sheets': {'FilterControls': {'Dropdown': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'List': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}},
'ParameterControls': {'Dropdown': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'List': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}}}
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 Quick Sight that identifies Amazon Quick Sight reports, created from analyses. You can share Amazon Quick Sight 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.
{'Credentials': {'CredentialPair': {'AlternateDataSourceParameters': {'AthenaParameters': {'ConsumerAccountRoleArn': 'string'},
'S3TablesParameters': {'TableBucketArn': 'string'}}}},
'DataSourceParameters': {'AthenaParameters': {'ConsumerAccountRoleArn': 'string'},
'S3TablesParameters': {'TableBucketArn': 'string'}},
'Type': {'S3_TABLES'}}
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'|'S3_TABLES'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY'|'GOOGLESHEETS'|'GOOGLE_DRIVE'|'CONFLUENCE'|'SHAREPOINT'|'ONE_DRIVE'|'WEB_CRAWLER'|'S3_KNOWLEDGE_BASE'|'QBUSINESS',
DataSourceParameters={
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string',
'ConsumerAccountRoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'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',
'UseServiceName': True|False
},
'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
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': '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',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
}
},
Credentials={
'CredentialPair': {
'Username': 'string',
'Password': 'string',
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string',
'ConsumerAccountRoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'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',
'UseServiceName': True|False
},
'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
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': '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',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
}
},
]
},
'CopySourceArn': 'string',
'SecretArn': 'string',
'KeyPairCredentials': {
'KeyPairUsername': 'string',
'PrivateKey': 'string',
'PrivateKeyPassphrase': 'string'
},
'WebProxyCredentials': {
'WebProxyUsername': 'string',
'WebProxyPassword': 'string'
},
'OAuthClientCredentials': {
'ClientId': 'string',
'ClientSecret': 'string',
'Username': '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 Quick Sight 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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
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 Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight 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 Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight 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, Quick Sight 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.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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 Quick Sight.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base 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 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) -- [REQUIRED]
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
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.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
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.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
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.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) -- [REQUIRED]
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) -- [REQUIRED]
The host name of the Impala data source.
Port (integer) -- [REQUIRED]
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) -- [REQUIRED]
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) -- [REQUIRED]
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Q Business application.
dict
The credentials Amazon Quick Sight 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 Quick Sight 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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
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 Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight 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 Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight 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, Quick Sight 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.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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 Quick Sight.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base 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 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) -- [REQUIRED]
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
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.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
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.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
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.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) -- [REQUIRED]
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) -- [REQUIRED]
The host name of the Impala data source.
Port (integer) -- [REQUIRED]
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) -- [REQUIRED]
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) -- [REQUIRED]
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Q Business application.
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.
KeyPairCredentials (dict) --
The credentials for connecting using key-pair.
KeyPairUsername (string) -- [REQUIRED]
Username
PrivateKey (string) -- [REQUIRED]
PrivateKey
PrivateKeyPassphrase (string) --
PrivateKeyPassphrase
WebProxyCredentials (dict) --
The credentials for connecting through a web proxy server.
WebProxyUsername (string) -- [REQUIRED]
The username for authenticating with the web proxy server.
WebProxyPassword (string) -- [REQUIRED]
The password for authenticating with the web proxy server.
OAuthClientCredentials (dict) --
The OAuth client credentials for connecting to a data source using OAuth 2.0 client credentials (2LO) authentication. For more information, see ``OAuthClientCredentials ``.
ClientId (string) --
The client ID of the OAuth 2.0 application that is registered with the data source provider.
ClientSecret (string) --
The client secret of the OAuth 2.0 application that is registered with the data source provider.
Username (string) --
The username of the account that is used for OAuth 2.0 client credentials authentication with the data source provider.
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 Quick Sight user or group associated with a data source or dataset. (This is common.)
The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)
The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (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 Quick Sight 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 Quick Sight 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 Quick Sight 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.
{'Definition': {'FilterGroups': {'Filters': {'CategoryFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'NestedFilter': {'InnerFilter': {'CategoryInnerFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}}}},
'NumericEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'NumericRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'RelativeDatesFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'TimeEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'TimeRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'TopBottomFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}}}},
'Sheets': {'FilterControls': {'Dropdown': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'List': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}},
'ParameterControls': {'Dropdown': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'List': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}}}
Creates a template either from a TemplateDefinition or from an existing Quick Sight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses.
A template is an entity in Quick Sight 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': {'CategoryFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'NestedFilter': {'InnerFilter': {'CategoryInnerFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}}}},
'NumericEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'NumericRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'RelativeDatesFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'TimeEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'TimeRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'TopBottomFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}}}},
'Sheets': {'FilterControls': {'Dropdown': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'List': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}},
'ParameterControls': {'Dropdown': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'List': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}}}
Provides a detailed description of the definition of an analysis.
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': {'AthenaParameters': {'ConsumerAccountRoleArn': 'string'},
'S3TablesParameters': {'TableBucketArn': 'string'}}}}}
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',
'ConsumerAccountRoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'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',
'UseServiceName': True|False
},
'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
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': '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',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
}
},
'VpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'SslProperties': {
'DisableSsl': True|False
},
'Credentials': {
'CredentialPair': {
'Username': 'string',
'Password': 'string'
},
'SecretArn': 'string'
}
},
],
'DataSets': [
{
'DataSetId': 'string',
'Name': 'string',
'DataSetRefreshProperties': {
'RefreshConfiguration': {
'IncrementalRefresh': {
'LookbackWindow': {
'ColumnName': 'string',
'Size': 123,
'SizeUnit': 'HOUR'|'DAY'|'WEEK'
}
}
},
'FailureConfiguration': {
'EmailAlert': {
'AlertStatus': 'ENABLED'|'DISABLED'
}
}
}
},
],
'Themes': [
{
'ThemeId': 'string',
'Name': 'string'
},
],
'Analyses': [
{
'AnalysisId': 'string',
'Name': 'string'
},
],
'Dashboards': [
{
'DashboardId': 'string',
'Name': 'string'
},
],
'Folders': [
{
'FolderId': 'string',
'Name': 'string',
'ParentFolderArn': 'string'
},
]
},
'FailureAction': 'DO_NOTHING'|'ROLLBACK',
'RequestId': 'string',
'Status': 123,
'OverridePermissions': {
'DataSources': [
{
'DataSourceIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'DataSets': [
{
'DataSetIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Themes': [
{
'ThemeIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Analyses': [
{
'AnalysisIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Dashboards': [
{
'DashboardIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
},
'LinkSharingConfiguration': {
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
}
},
],
'Folders': [
{
'FolderIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
]
},
'OverrideTags': {
'VPCConnections': [
{
'VPCConnectionIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'DataSources': [
{
'DataSourceIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'DataSets': [
{
'DataSetIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Themes': [
{
'ThemeIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Analyses': [
{
'AnalysisIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Dashboards': [
{
'DashboardIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Folders': [
{
'FolderIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
},
'OverrideValidationStrategy': {
'StrictModeForAllResources': True|False
},
'Warnings': [
{
'Arn': 'string',
'Message': 'string'
},
]
}
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 that are 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 Quick Sight 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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
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 Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight 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 Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight 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, Quick Sight 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.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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 Quick Sight.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base 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 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) --
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
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.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
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.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
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.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) --
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) --
The host name of the Impala data source.
Port (integer) --
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) --
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) --
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) --
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q Business application.
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 Quick Sight 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.
DataSetRefreshProperties (dict) --
The refresh properties of a dataset.
RefreshConfiguration (dict) --
The refresh configuration for a dataset.
IncrementalRefresh (dict) --
The incremental refresh for the dataset.
LookbackWindow (dict) --
The lookback window setup for an incremental refresh configuration.
ColumnName (string) --
The name of the lookback window column.
Size (integer) --
The lookback window column size.
SizeUnit (string) --
The size unit that is used for the lookback window column. Valid values for this structure are HOUR, DAY, and WEEK.
FailureConfiguration (dict) --
The failure configuration for a dataset.
EmailAlert (dict) --
The email alert configuration for a dataset refresh failure.
AlertStatus (string) --
The status value that determines if email alerts are sent.
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.
Folders (list) --
A list of overrides for any Folder resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single folder that is being imported.
FolderId (string) --
The ID of the folder that you want to apply overrides to.
Name (string) --
A new name for the folder.
ParentFolderArn (string) --
A new parent folder arn. This change can only be applied if the import creates a brand new folder. Existing folders cannot be moved.
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.
OverridePermissions (dict) --
Optional permission overrides that are applied to the resource configuration before import.
DataSources (list) --
A list of permissions overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of data source IDs.
DataSourceIds (list) --
A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the data source that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
DataSets (list) --
A list of permissions overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of dataset IDs.
DataSetIds (list) --
A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the datasets that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
Themes (list) --
A list of permissions overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of theme IDs.
ThemeIds (list) --
A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the themes that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
Analyses (list) --
A list of permissions overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of analysis IDs.
AnalysisIds (list) --
A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the analyses that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
Dashboards (list) --
A list of permissions overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of dashboard IDs.
DashboardIds (list) --
A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the dashboards that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
LinkSharingConfiguration (dict) --
A structure that contains the link sharing configurations that you want to apply overrides to.
Permissions (dict) --
A list of link sharing permissions for the dashboards that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
Folders (list) --
A list of permissions for the folders that you want to apply overrides to.
(dict) --
An object that contains a list of permissions to be applied to a list of folder IDs.
FolderIds (list) --
A list of folder IDs that you want to apply overrides to. You can use * to override all folders in this asset bundle.
(string) --
Permissions (dict) --
A structure that contains the permissions for the resource that you want to override in an asset bundle import job.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
OverrideTags (dict) --
Optional tag overrides that are applied to the resource configuration before import.
VPCConnections (list) --
A list of tag overrides for any VPCConnection resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of VPC connection IDs.
VPCConnectionIds (list) --
A list of VPC connection IDs that you want to apply overrides to. You can use * to override all VPC connections in this asset bundle.
(string) --
Tags (list) --
A list of tags for the VPC connections that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
DataSources (list) --
A list of tag overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of data source IDs.
DataSourceIds (list) --
A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.
(string) --
Tags (list) --
A list of tags for the data source that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
DataSets (list) --
A list of tag overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of dataset IDs.
DataSetIds (list) --
A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.
(string) --
Tags (list) --
A list of tags for the datasets that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
Themes (list) --
A list of tag overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of theme IDs.
ThemeIds (list) --
A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.
(string) --
Tags (list) --
A list of tags for the themes that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
Analyses (list) --
A list of tag overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of analysis IDs.
AnalysisIds (list) --
A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.
(string) --
Tags (list) --
A list of tags for the analyses that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
Dashboards (list) --
A list of tag overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of dashboard IDs.
DashboardIds (list) --
A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.
(string) --
Tags (list) --
A list of tags for the dashboards that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
Folders (list) --
A list of tag overrides for any Folder resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of folder IDs.
FolderIds (list) --
A list of folder IDs that you want to apply overrides to. You can use * to override all folders in this asset bundle.
(string) --
Tags (list) --
A list of tags for the folders that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
OverrideValidationStrategy (dict) --
An optional validation strategy override for all analyses and dashboards to be applied to the resource configuration before import.
StrictModeForAllResources (boolean) --
A Boolean value that indicates whether to import all analyses and dashboards under strict or lenient mode.
Warnings (list) --
An array of warning records that describe all permitted errors that are encountered during the import job.
(dict) --
Describes a warning that occurred during an Asset Bundle import job.
Arn (string) --
The ARN of the resource that the warning occurred for.
Message (string) --
A description of the warning that occurred during an Asset Bundle import job.
{'CustomPermissions': {'Capabilities': {'GenerateAnalyses': 'DENY'}}}
Describes a custom permissions profile.
See also: AWS API Documentation
Request Syntax
client.describe_custom_permissions(
AwsAccountId='string',
CustomPermissionsName='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the custom permissions profile that you want described.
string
[REQUIRED]
The name of the custom permissions profile to describe.
dict
Response Syntax
{
'Status': 123,
'CustomPermissions': {
'Arn': 'string',
'CustomPermissionsName': 'string',
'Capabilities': {
'ExportToCsv': 'DENY',
'ExportToExcel': 'DENY',
'ExportToPdf': 'DENY',
'PrintReports': 'DENY',
'CreateAndUpdateThemes': 'DENY',
'AddOrRunAnomalyDetectionForAnalyses': 'DENY',
'ShareAnalyses': 'DENY',
'CreateAndUpdateDatasets': 'DENY',
'ShareDatasets': 'DENY',
'SubscribeDashboardEmailReports': 'DENY',
'CreateAndUpdateDashboardEmailReports': 'DENY',
'ShareDashboards': 'DENY',
'CreateAndUpdateThresholdAlerts': 'DENY',
'RenameSharedFolders': 'DENY',
'CreateSharedFolders': 'DENY',
'CreateAndUpdateDataSources': 'DENY',
'ShareDataSources': 'DENY',
'ViewAccountSPICECapacity': 'DENY',
'CreateSPICEDataset': 'DENY',
'ExportToPdfInScheduledReports': 'DENY',
'ExportToCsvInScheduledReports': 'DENY',
'ExportToExcelInScheduledReports': 'DENY',
'IncludeContentInScheduledReportsEmail': 'DENY',
'Dashboard': 'DENY',
'Analysis': 'DENY',
'Automate': 'DENY',
'Flow': 'DENY',
'PublishWithoutApproval': 'DENY',
'UseBedrockModels': 'DENY',
'PerformFlowUiTask': 'DENY',
'ApproveFlowShareRequests': 'DENY',
'UseAgentWebSearch': 'DENY',
'KnowledgeBase': 'DENY',
'Action': 'DENY',
'GenericHTTPAction': 'DENY',
'CreateAndUpdateGenericHTTPAction': 'DENY',
'ShareGenericHTTPAction': 'DENY',
'UseGenericHTTPAction': 'DENY',
'AsanaAction': 'DENY',
'CreateAndUpdateAsanaAction': 'DENY',
'ShareAsanaAction': 'DENY',
'UseAsanaAction': 'DENY',
'SlackAction': 'DENY',
'CreateAndUpdateSlackAction': 'DENY',
'ShareSlackAction': 'DENY',
'UseSlackAction': 'DENY',
'ServiceNowAction': 'DENY',
'CreateAndUpdateServiceNowAction': 'DENY',
'ShareServiceNowAction': 'DENY',
'UseServiceNowAction': 'DENY',
'SalesforceAction': 'DENY',
'CreateAndUpdateSalesforceAction': 'DENY',
'ShareSalesforceAction': 'DENY',
'UseSalesforceAction': 'DENY',
'MSExchangeAction': 'DENY',
'CreateAndUpdateMSExchangeAction': 'DENY',
'ShareMSExchangeAction': 'DENY',
'UseMSExchangeAction': 'DENY',
'PagerDutyAction': 'DENY',
'CreateAndUpdatePagerDutyAction': 'DENY',
'SharePagerDutyAction': 'DENY',
'UsePagerDutyAction': 'DENY',
'JiraAction': 'DENY',
'CreateAndUpdateJiraAction': 'DENY',
'ShareJiraAction': 'DENY',
'UseJiraAction': 'DENY',
'ConfluenceAction': 'DENY',
'CreateAndUpdateConfluenceAction': 'DENY',
'ShareConfluenceAction': 'DENY',
'UseConfluenceAction': 'DENY',
'OneDriveAction': 'DENY',
'CreateAndUpdateOneDriveAction': 'DENY',
'ShareOneDriveAction': 'DENY',
'UseOneDriveAction': 'DENY',
'SharePointAction': 'DENY',
'CreateAndUpdateSharePointAction': 'DENY',
'ShareSharePointAction': 'DENY',
'UseSharePointAction': 'DENY',
'MSTeamsAction': 'DENY',
'CreateAndUpdateMSTeamsAction': 'DENY',
'ShareMSTeamsAction': 'DENY',
'UseMSTeamsAction': 'DENY',
'GoogleCalendarAction': 'DENY',
'CreateAndUpdateGoogleCalendarAction': 'DENY',
'ShareGoogleCalendarAction': 'DENY',
'UseGoogleCalendarAction': 'DENY',
'ZendeskAction': 'DENY',
'CreateAndUpdateZendeskAction': 'DENY',
'ShareZendeskAction': 'DENY',
'UseZendeskAction': 'DENY',
'SmartsheetAction': 'DENY',
'CreateAndUpdateSmartsheetAction': 'DENY',
'ShareSmartsheetAction': 'DENY',
'UseSmartsheetAction': 'DENY',
'SAPBusinessPartnerAction': 'DENY',
'CreateAndUpdateSAPBusinessPartnerAction': 'DENY',
'ShareSAPBusinessPartnerAction': 'DENY',
'UseSAPBusinessPartnerAction': 'DENY',
'SAPProductMasterDataAction': 'DENY',
'CreateAndUpdateSAPProductMasterDataAction': 'DENY',
'ShareSAPProductMasterDataAction': 'DENY',
'UseSAPProductMasterDataAction': 'DENY',
'SAPPhysicalInventoryAction': 'DENY',
'CreateAndUpdateSAPPhysicalInventoryAction': 'DENY',
'ShareSAPPhysicalInventoryAction': 'DENY',
'UseSAPPhysicalInventoryAction': 'DENY',
'SAPBillOfMaterialAction': 'DENY',
'CreateAndUpdateSAPBillOfMaterialAction': 'DENY',
'ShareSAPBillOfMaterialAction': 'DENY',
'UseSAPBillOfMaterialAction': 'DENY',
'SAPMaterialStockAction': 'DENY',
'CreateAndUpdateSAPMaterialStockAction': 'DENY',
'ShareSAPMaterialStockAction': 'DENY',
'UseSAPMaterialStockAction': 'DENY',
'FactSetAction': 'DENY',
'CreateAndUpdateFactSetAction': 'DENY',
'ShareFactSetAction': 'DENY',
'UseFactSetAction': 'DENY',
'AmazonSThreeAction': 'DENY',
'CreateAndUpdateAmazonSThreeAction': 'DENY',
'ShareAmazonSThreeAction': 'DENY',
'UseAmazonSThreeAction': 'DENY',
'TextractAction': 'DENY',
'CreateAndUpdateTextractAction': 'DENY',
'ShareTextractAction': 'DENY',
'UseTextractAction': 'DENY',
'ComprehendAction': 'DENY',
'CreateAndUpdateComprehendAction': 'DENY',
'ShareComprehendAction': 'DENY',
'UseComprehendAction': 'DENY',
'ComprehendMedicalAction': 'DENY',
'CreateAndUpdateComprehendMedicalAction': 'DENY',
'ShareComprehendMedicalAction': 'DENY',
'UseComprehendMedicalAction': 'DENY',
'AmazonBedrockARSAction': 'DENY',
'CreateAndUpdateAmazonBedrockARSAction': 'DENY',
'ShareAmazonBedrockARSAction': 'DENY',
'UseAmazonBedrockARSAction': 'DENY',
'AmazonBedrockFSAction': 'DENY',
'CreateAndUpdateAmazonBedrockFSAction': 'DENY',
'ShareAmazonBedrockFSAction': 'DENY',
'UseAmazonBedrockFSAction': 'DENY',
'AmazonBedrockKRSAction': 'DENY',
'CreateAndUpdateAmazonBedrockKRSAction': 'DENY',
'ShareAmazonBedrockKRSAction': 'DENY',
'UseAmazonBedrockKRSAction': 'DENY',
'MCPAction': 'DENY',
'CreateAndUpdateMCPAction': 'DENY',
'ShareMCPAction': 'DENY',
'UseMCPAction': 'DENY',
'OpenAPIAction': 'DENY',
'CreateAndUpdateOpenAPIAction': 'DENY',
'ShareOpenAPIAction': 'DENY',
'UseOpenAPIAction': 'DENY',
'SandPGMIAction': 'DENY',
'CreateAndUpdateSandPGMIAction': 'DENY',
'ShareSandPGMIAction': 'DENY',
'UseSandPGMIAction': 'DENY',
'SandPGlobalEnergyAction': 'DENY',
'CreateAndUpdateSandPGlobalEnergyAction': 'DENY',
'ShareSandPGlobalEnergyAction': 'DENY',
'UseSandPGlobalEnergyAction': 'DENY',
'BambooHRAction': 'DENY',
'CreateAndUpdateBambooHRAction': 'DENY',
'ShareBambooHRAction': 'DENY',
'UseBambooHRAction': 'DENY',
'BoxAgentAction': 'DENY',
'CreateAndUpdateBoxAgentAction': 'DENY',
'ShareBoxAgentAction': 'DENY',
'UseBoxAgentAction': 'DENY',
'CanvaAgentAction': 'DENY',
'CreateAndUpdateCanvaAgentAction': 'DENY',
'ShareCanvaAgentAction': 'DENY',
'UseCanvaAgentAction': 'DENY',
'GithubAction': 'DENY',
'CreateAndUpdateGithubAction': 'DENY',
'ShareGithubAction': 'DENY',
'UseGithubAction': 'DENY',
'NotionAction': 'DENY',
'CreateAndUpdateNotionAction': 'DENY',
'ShareNotionAction': 'DENY',
'UseNotionAction': 'DENY',
'LinearAction': 'DENY',
'CreateAndUpdateLinearAction': 'DENY',
'ShareLinearAction': 'DENY',
'UseLinearAction': 'DENY',
'HuggingFaceAction': 'DENY',
'CreateAndUpdateHuggingFaceAction': 'DENY',
'ShareHuggingFaceAction': 'DENY',
'UseHuggingFaceAction': 'DENY',
'MondayAction': 'DENY',
'CreateAndUpdateMondayAction': 'DENY',
'ShareMondayAction': 'DENY',
'UseMondayAction': 'DENY',
'HubspotAction': 'DENY',
'CreateAndUpdateHubspotAction': 'DENY',
'ShareHubspotAction': 'DENY',
'UseHubspotAction': 'DENY',
'IntercomAction': 'DENY',
'CreateAndUpdateIntercomAction': 'DENY',
'ShareIntercomAction': 'DENY',
'UseIntercomAction': 'DENY',
'NewRelicAction': 'DENY',
'CreateAndUpdateNewRelicAction': 'DENY',
'ShareNewRelicAction': 'DENY',
'UseNewRelicAction': 'DENY',
'Topic': 'DENY',
'EditVisualWithQ': 'DENY',
'BuildCalculatedFieldWithQ': 'DENY',
'CreateDashboardExecutiveSummaryWithQ': 'DENY',
'Space': 'DENY',
'CreateSpaces': 'DENY',
'ShareSpaces': 'DENY',
'ChatAgent': 'DENY',
'CreateChatAgents': 'DENY',
'ShareChatAgents': 'DENY',
'Research': 'DENY',
'SelfUpgradeUserRole': 'DENY',
'Extension': 'DENY',
'ManageSharedFolders': 'DENY',
'GenerateAnalyses': 'DENY'
}
},
'RequestId': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
CustomPermissions (dict) --
The custom permissions profile.
Arn (string) --
The Amazon Resource Name (ARN) of the custom permissions profile.
CustomPermissionsName (string) --
The name of the custom permissions profile.
Capabilities (dict) --
A set of actions in the custom permissions profile.
ExportToCsv (string) --
The ability to export to CSV files from the UI.
ExportToExcel (string) --
The ability to export to Excel files from the UI.
ExportToPdf (string) --
The ability to export to PDF files from the UI.
PrintReports (string) --
The ability to print reports.
CreateAndUpdateThemes (string) --
The ability to export to Create and Update themes.
AddOrRunAnomalyDetectionForAnalyses (string) --
The ability to add or run anomaly detection.
ShareAnalyses (string) --
The ability to share analyses.
CreateAndUpdateDatasets (string) --
The ability to create and update datasets.
ShareDatasets (string) --
The ability to share datasets.
SubscribeDashboardEmailReports (string) --
The ability to subscribe to email reports.
CreateAndUpdateDashboardEmailReports (string) --
The ability to create and update email reports.
ShareDashboards (string) --
The ability to share dashboards.
CreateAndUpdateThresholdAlerts (string) --
The ability to create and update threshold alerts.
RenameSharedFolders (string) --
The ability to rename shared folders.
CreateSharedFolders (string) --
The ability to create shared folders.
CreateAndUpdateDataSources (string) --
The ability to create and update data sources.
ShareDataSources (string) --
The ability to share data sources.
ViewAccountSPICECapacity (string) --
The ability to view account SPICE capacity.
CreateSPICEDataset (string) --
The ability to create a SPICE dataset.
ExportToPdfInScheduledReports (string) --
The ability to export to PDF files in scheduled email reports.
ExportToCsvInScheduledReports (string) --
The ability to export to CSV files in scheduled email reports.
ExportToExcelInScheduledReports (string) --
The ability to export to Excel files in scheduled email reports.
IncludeContentInScheduledReportsEmail (string) --
The ability to include content in scheduled email reports.
Dashboard (string) --
The ability to perform dashboard-related actions.
Analysis (string) --
The ability to perform analysis-related actions.
Automate (string) --
The ability to perform automate-related actions.
Flow (string) --
The ability to perform flow-related actions.
PublishWithoutApproval (string) --
The ability to enable approvals for flow share.
UseBedrockModels (string) --
The ability to use Bedrock models for general knowledge step in flows.
PerformFlowUiTask (string) --
The ability to use UI Agent step to perform tasks on public websites.
ApproveFlowShareRequests (string) --
The ability to review and approve sharing requests of Flows.
UseAgentWebSearch (string) --
The ability to use internet to enhance results in Chat Agents, Flows, and Quick Research. Web search queries will be processed securely in an Amazon Web Services region us-east-1.
KnowledgeBase (string) --
The ability to use knowledge bases to specify content from external applications.
Action (string) --
The ability to perform actions in external services through Action connectors. Actions allow users to interact with third-party systems.
GenericHTTPAction (string) --
The ability to perform actions using REST API connection connectors.
CreateAndUpdateGenericHTTPAction (string) --
The ability to create and update REST API connection actions.
ShareGenericHTTPAction (string) --
The ability to share REST API connection actions.
UseGenericHTTPAction (string) --
The ability to use REST API connection actions.
AsanaAction (string) --
The ability to perform actions using Asana connectors.
CreateAndUpdateAsanaAction (string) --
The ability to create and update Asana actions.
ShareAsanaAction (string) --
The ability to share Asana actions.
UseAsanaAction (string) --
The ability to use Asana actions.
SlackAction (string) --
The ability to perform actions using Slack connectors.
CreateAndUpdateSlackAction (string) --
The ability to create and update Slack actions.
ShareSlackAction (string) --
The ability to share Slack actions.
UseSlackAction (string) --
The ability to use Slack actions.
ServiceNowAction (string) --
The ability to perform actions using ServiceNow connectors.
CreateAndUpdateServiceNowAction (string) --
The ability to create and update ServiceNow actions.
ShareServiceNowAction (string) --
The ability to share ServiceNow actions.
UseServiceNowAction (string) --
The ability to use ServiceNow actions.
SalesforceAction (string) --
The ability to perform actions using Salesforce connectors.
CreateAndUpdateSalesforceAction (string) --
The ability to create and update Salesforce actions.
ShareSalesforceAction (string) --
The ability to share Salesforce actions.
UseSalesforceAction (string) --
The ability to use Salesforce actions.
MSExchangeAction (string) --
The ability to perform actions using Microsoft Outlook connectors.
CreateAndUpdateMSExchangeAction (string) --
The ability to create and update Microsoft Outlook actions.
ShareMSExchangeAction (string) --
The ability to share Microsoft Outlook actions.
UseMSExchangeAction (string) --
The ability to use Microsoft Outlook actions.
PagerDutyAction (string) --
The ability to perform actions using PagerDuty Advance connectors.
CreateAndUpdatePagerDutyAction (string) --
The ability to create and update PagerDuty Advance actions.
SharePagerDutyAction (string) --
The ability to share PagerDuty Advance actions.
UsePagerDutyAction (string) --
The ability to use PagerDuty Advance actions.
JiraAction (string) --
The ability to perform actions using Jira connectors.
CreateAndUpdateJiraAction (string) --
The ability to create and update Jira actions.
ShareJiraAction (string) --
The ability to share Jira actions.
UseJiraAction (string) --
The ability to use Jira actions.
ConfluenceAction (string) --
The ability to perform actions using Atlassian Confluence Cloud connectors.
CreateAndUpdateConfluenceAction (string) --
The ability to create and update Atlassian Confluence Cloud actions.
ShareConfluenceAction (string) --
The ability to share Atlassian Confluence Cloud actions.
UseConfluenceAction (string) --
The ability to use Atlassian Confluence Cloud actions.
OneDriveAction (string) --
The ability to perform actions using Microsoft OneDrive connectors.
CreateAndUpdateOneDriveAction (string) --
The ability to create and update Microsoft OneDrive actions.
ShareOneDriveAction (string) --
The ability to share Microsoft OneDrive actions.
UseOneDriveAction (string) --
The ability to use Microsoft OneDrive actions.
SharePointAction (string) --
The ability to perform actions using Microsoft SharePoint Online connectors.
CreateAndUpdateSharePointAction (string) --
The ability to create and update Microsoft SharePoint Online actions.
ShareSharePointAction (string) --
The ability to share Microsoft SharePoint Online actions.
UseSharePointAction (string) --
The ability to use Microsoft SharePoint Online actions.
MSTeamsAction (string) --
The ability to perform actions using Microsoft Teams connectors.
CreateAndUpdateMSTeamsAction (string) --
The ability to create and update Microsoft Teams actions.
ShareMSTeamsAction (string) --
The ability to share Microsoft Teams actions.
UseMSTeamsAction (string) --
The ability to use Microsoft Teams actions.
GoogleCalendarAction (string) --
The ability to perform actions using Google Calendar connectors.
CreateAndUpdateGoogleCalendarAction (string) --
The ability to create and update Google Calendar actions.
ShareGoogleCalendarAction (string) --
The ability to share Google Calendar actions.
UseGoogleCalendarAction (string) --
The ability to use Google Calendar actions.
ZendeskAction (string) --
The ability to perform actions using Zendesk connectors.
CreateAndUpdateZendeskAction (string) --
The ability to create and update Zendesk actions.
ShareZendeskAction (string) --
The ability to share Zendesk actions.
UseZendeskAction (string) --
The ability to use Zendesk actions.
SmartsheetAction (string) --
The ability to perform actions using Smartsheet connectors.
CreateAndUpdateSmartsheetAction (string) --
The ability to create and update Smartsheet actions.
ShareSmartsheetAction (string) --
The ability to share Smartsheet actions.
UseSmartsheetAction (string) --
The ability to use Smartsheet actions.
SAPBusinessPartnerAction (string) --
The ability to perform actions using SAP Business Partner connectors.
CreateAndUpdateSAPBusinessPartnerAction (string) --
The ability to create and update SAP Business Partner actions.
ShareSAPBusinessPartnerAction (string) --
The ability to share SAP Business Partner actions.
UseSAPBusinessPartnerAction (string) --
The ability to use SAP Business Partner actions.
SAPProductMasterDataAction (string) --
The ability to perform actions using SAP Product Master connectors.
CreateAndUpdateSAPProductMasterDataAction (string) --
The ability to create and update SAP Product Master actions.
ShareSAPProductMasterDataAction (string) --
The ability to share SAP Product Master actions.
UseSAPProductMasterDataAction (string) --
The ability to use SAP Product Master actions.
SAPPhysicalInventoryAction (string) --
The ability to perform actions using SAP Physical Inventory connectors.
CreateAndUpdateSAPPhysicalInventoryAction (string) --
The ability to create and update SAP Physical Inventory actions.
ShareSAPPhysicalInventoryAction (string) --
The ability to share SAP Physical Inventory actions.
UseSAPPhysicalInventoryAction (string) --
The ability to use SAP Physical Inventory actions.
SAPBillOfMaterialAction (string) --
The ability to perform actions using SAP Bill of Materials connectors.
CreateAndUpdateSAPBillOfMaterialAction (string) --
The ability to create and update SAP Bill of Materials actions.
ShareSAPBillOfMaterialAction (string) --
The ability to share SAP Bill of Materials actions.
UseSAPBillOfMaterialAction (string) --
The ability to use SAP Bill of Materials actions.
SAPMaterialStockAction (string) --
The ability to perform actions using SAP Material Stock connectors.
CreateAndUpdateSAPMaterialStockAction (string) --
The ability to create and update SAP Material Stock actions.
ShareSAPMaterialStockAction (string) --
The ability to share SAP Material Stock actions.
UseSAPMaterialStockAction (string) --
The ability to use SAP Material Stock actions.
FactSetAction (string) --
The ability to perform actions using FactSet connectors.
CreateAndUpdateFactSetAction (string) --
The ability to create and update FactSet actions.
ShareFactSetAction (string) --
The ability to share FactSet actions.
UseFactSetAction (string) --
The ability to use FactSet actions.
AmazonSThreeAction (string) --
The ability to perform actions using Amazon S3 connectors.
CreateAndUpdateAmazonSThreeAction (string) --
The ability to create and update Amazon S3 actions.
ShareAmazonSThreeAction (string) --
The ability to share Amazon S3 actions.
UseAmazonSThreeAction (string) --
The ability to use Amazon S3 actions.
TextractAction (string) --
The ability to perform actions using Textract connectors.
CreateAndUpdateTextractAction (string) --
The ability to create and update Textract actions.
ShareTextractAction (string) --
The ability to share Textract actions.
UseTextractAction (string) --
The ability to use Textract actions.
ComprehendAction (string) --
The ability to perform actions using Comprehend connectors.
CreateAndUpdateComprehendAction (string) --
The ability to create and update Comprehend actions.
ShareComprehendAction (string) --
The ability to share Comprehend actions.
UseComprehendAction (string) --
The ability to use Comprehend actions.
ComprehendMedicalAction (string) --
The ability to perform actions using Comprehend Medical connectors.
CreateAndUpdateComprehendMedicalAction (string) --
The ability to create and update Comprehend Medical actions.
ShareComprehendMedicalAction (string) --
The ability to share Comprehend Medical actions.
UseComprehendMedicalAction (string) --
The ability to use Comprehend Medical actions.
AmazonBedrockARSAction (string) --
The ability to perform actions using Bedrock Agent connectors.
CreateAndUpdateAmazonBedrockARSAction (string) --
The ability to create and update Bedrock Agent actions.
ShareAmazonBedrockARSAction (string) --
The ability to share Bedrock Agent actions.
UseAmazonBedrockARSAction (string) --
The ability to use Bedrock Agent actions.
AmazonBedrockFSAction (string) --
The ability to perform actions using Bedrock Runtime connectors.
CreateAndUpdateAmazonBedrockFSAction (string) --
The ability to create and update Bedrock Runtime actions.
ShareAmazonBedrockFSAction (string) --
The ability to share Bedrock Runtime actions.
UseAmazonBedrockFSAction (string) --
The ability to use Bedrock Runtime actions.
AmazonBedrockKRSAction (string) --
The ability to perform actions using Bedrock Data Automation Runtime connectors.
CreateAndUpdateAmazonBedrockKRSAction (string) --
The ability to create and update Bedrock Data Automation Runtime actions.
ShareAmazonBedrockKRSAction (string) --
The ability to share Bedrock Data Automation Runtime actions.
UseAmazonBedrockKRSAction (string) --
The ability to use Bedrock Data Automation Runtime actions.
MCPAction (string) --
The ability to perform actions using Model Context Protocol connectors.
CreateAndUpdateMCPAction (string) --
The ability to create and update Model Context Protocol actions.
ShareMCPAction (string) --
The ability to share Model Context Protocol actions.
UseMCPAction (string) --
The ability to use Model Context Protocol actions.
OpenAPIAction (string) --
The ability to perform actions using OpenAPI Specification connectors.
CreateAndUpdateOpenAPIAction (string) --
The ability to create and update OpenAPI Specification actions.
ShareOpenAPIAction (string) --
The ability to share OpenAPI Specification actions.
UseOpenAPIAction (string) --
The ability to use OpenAPI Specification actions.
SandPGMIAction (string) --
The ability to perform actions using S&P Global Market Intelligence connectors.
CreateAndUpdateSandPGMIAction (string) --
The ability to create and update S&P Global Market Intelligence actions.
ShareSandPGMIAction (string) --
The ability to share S&P Global Market Intelligence actions.
UseSandPGMIAction (string) --
The ability to use S&P Global Market Intelligence actions.
SandPGlobalEnergyAction (string) --
The ability to perform actions using S&P Global Energy connectors.
CreateAndUpdateSandPGlobalEnergyAction (string) --
The ability to create and update S&P Global Energy actions.
ShareSandPGlobalEnergyAction (string) --
The ability to share S&P Global Energy actions.
UseSandPGlobalEnergyAction (string) --
The ability to use S&P Global Energy actions.
BambooHRAction (string) --
The ability to perform actions using BambooHR connectors.
CreateAndUpdateBambooHRAction (string) --
The ability to create and update BambooHR actions.
ShareBambooHRAction (string) --
The ability to share BambooHR actions.
UseBambooHRAction (string) --
The ability to use BambooHR actions.
BoxAgentAction (string) --
The ability to perform actions using Box Agent connectors.
CreateAndUpdateBoxAgentAction (string) --
The ability to create and update Box Agent actions.
ShareBoxAgentAction (string) --
The ability to share Box Agent actions.
UseBoxAgentAction (string) --
The ability to use Box Agent actions.
CanvaAgentAction (string) --
The ability to perform actions using Canva Agent connectors.
CreateAndUpdateCanvaAgentAction (string) --
The ability to create and update Canva Agent actions.
ShareCanvaAgentAction (string) --
The ability to share Canva Agent actions.
UseCanvaAgentAction (string) --
The ability to use Canva Agent actions.
GithubAction (string) --
The ability to perform actions using GitHub connectors.
CreateAndUpdateGithubAction (string) --
The ability to create and update GitHub actions.
ShareGithubAction (string) --
The ability to share GitHub actions.
UseGithubAction (string) --
The ability to use GitHub actions.
NotionAction (string) --
The ability to perform actions using Notion connectors.
CreateAndUpdateNotionAction (string) --
The ability to create and update Notion actions.
ShareNotionAction (string) --
The ability to share Notion actions.
UseNotionAction (string) --
The ability to use Notion actions.
LinearAction (string) --
The ability to perform actions using Linear connectors.
CreateAndUpdateLinearAction (string) --
The ability to create and update Linear actions.
ShareLinearAction (string) --
The ability to share Linear actions.
UseLinearAction (string) --
The ability to use Linear actions.
HuggingFaceAction (string) --
The ability to perform actions using HuggingFace connectors.
CreateAndUpdateHuggingFaceAction (string) --
The ability to create and update HuggingFace actions.
ShareHuggingFaceAction (string) --
The ability to share HuggingFace actions.
UseHuggingFaceAction (string) --
The ability to use HuggingFace actions.
MondayAction (string) --
The ability to perform actions using Monday connectors.
CreateAndUpdateMondayAction (string) --
The ability to create and update Monday actions.
ShareMondayAction (string) --
The ability to share Monday actions.
UseMondayAction (string) --
The ability to use Monday actions.
HubspotAction (string) --
The ability to perform actions using Hubspot connectors.
CreateAndUpdateHubspotAction (string) --
The ability to create and update Hubspot actions.
ShareHubspotAction (string) --
The ability to share Hubspot actions.
UseHubspotAction (string) --
The ability to use Hubspot actions.
IntercomAction (string) --
The ability to perform actions using Intercom connectors.
CreateAndUpdateIntercomAction (string) --
The ability to create and update Intercom actions.
ShareIntercomAction (string) --
The ability to share Intercom actions.
UseIntercomAction (string) --
The ability to use Intercom actions.
NewRelicAction (string) --
The ability to perform actions using New Relic connectors.
CreateAndUpdateNewRelicAction (string) --
The ability to create and update New Relic actions.
ShareNewRelicAction (string) --
The ability to share New Relic actions.
UseNewRelicAction (string) --
The ability to use New Relic actions.
Topic (string) --
The ability to perform Topic-related actions.
EditVisualWithQ (string) --
The ability to Edit Visual with AI
BuildCalculatedFieldWithQ (string) --
The ability to Build Calculation with AI
CreateDashboardExecutiveSummaryWithQ (string) --
The ability to Create Executive Summary
Space (string) --
The ability to perform space-related actions.
CreateSpaces (string) --
The ability to create spaces.
ShareSpaces (string) --
The ability to share spaces with other users and groups.
ChatAgent (string) --
The ability to perform chat-related actions.
CreateChatAgents (string) --
The ability to create chat agents.
ShareChatAgents (string) --
The ability to share chat agents with other users and groups.
Research (string) --
The ability to perform research-related actions.
SelfUpgradeUserRole (string) --
The ability to enable users to upgrade their user role.
Extension (string) --
The ability to perform Extension-related actions.
ManageSharedFolders (string) --
The ability to create, update, delete and view shared folders (both restricted and unrestricted), ability to add any asset to shared folders, and ability to share the folders.
Note: This does not prevent inheriting access to assets that others share with them through folder membership.
GenerateAnalyses (string) --
The ability to generate analysis using AI
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'FilterGroups': {'Filters': {'CategoryFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'NestedFilter': {'InnerFilter': {'CategoryInnerFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}}}},
'NumericEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'NumericRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'RelativeDatesFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'TimeEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'TimeRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'TopBottomFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}}}},
'Sheets': {'FilterControls': {'Dropdown': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'List': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}},
'ParameterControls': {'Dropdown': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'List': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}}}
Provides a detailed description of the definition of a dashboard.
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': {'AthenaParameters': {'ConsumerAccountRoleArn': 'string'},
'S3TablesParameters': {'TableBucketArn': 'string'}},
'DataSourceParameters': {'AthenaParameters': {'ConsumerAccountRoleArn': 'string'},
'S3TablesParameters': {'TableBucketArn': 'string'}},
'Type': {'S3_TABLES'}}}
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'|'S3_TABLES'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY'|'GOOGLESHEETS'|'GOOGLE_DRIVE'|'CONFLUENCE'|'SHAREPOINT'|'ONE_DRIVE'|'WEB_CRAWLER'|'S3_KNOWLEDGE_BASE'|'QBUSINESS',
'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',
'ConsumerAccountRoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'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',
'UseServiceName': True|False
},
'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
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': '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',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
}
},
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string',
'ConsumerAccountRoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'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',
'UseServiceName': True|False
},
'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
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': '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',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': '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 Quick Sight 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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
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 Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight 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 Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight 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, Quick Sight 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.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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 Quick Sight.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base 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 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) --
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
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.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
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.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
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.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) --
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) --
The host name of the Impala data source.
Port (integer) --
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) --
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) --
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) --
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q Business application.
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 Quick Sight 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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
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 Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight 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 Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight 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, Quick Sight 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.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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 Quick Sight.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base 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 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) --
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
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.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
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.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
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.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) --
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) --
The host name of the Impala data source.
Port (integer) --
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) --
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) --
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) --
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q Business application.
VpcConnectionProperties (dict) --
The VPC connection information. You need to use this parameter only when you want Quick Sight 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 Quick Sight 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.
{'Definition': {'FilterGroups': {'Filters': {'CategoryFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'NestedFilter': {'InnerFilter': {'CategoryInnerFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}}}},
'NumericEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'NumericRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'RelativeDatesFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'TimeEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'TimeRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'TopBottomFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}}}},
'Sheets': {'FilterControls': {'Dropdown': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'List': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}},
'ParameterControls': {'Dropdown': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'List': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}}}
Provides a detailed description of the definition of a template.
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.
{'ExperienceConfiguration': {'Dashboard': {'FeatureConfigurations': {'DashboardCustomizationSummary': {'Enabled': 'boolean'}}},
'QuickSightConsole': {'FeatureConfigurations': {'DashboardCustomizationSummary': {'Enabled': 'boolean'}}}}}
Generates an embed URL that you can use to embed an Amazon Quick experience in your website. This action can be used for any type of user registered in an Amazon Quick account. Before you use this action, make sure that you have configured the relevant Amazon Quick resource and permissions.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.
You are charged only when the URL is used or there is interaction with Amazon Quick.
For more information, see Embedded Analytics in the Amazon Quick User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon Quick Developer Portal.
See also: AWS API Documentation
Request Syntax
client.generate_embed_url_for_registered_user(
AwsAccountId='string',
SessionLifetimeInMinutes=123,
UserArn='string',
ExperienceConfiguration={
'Dashboard': {
'InitialDashboardId': 'string',
'FeatureConfigurations': {
'StatePersistence': {
'Enabled': True|False
},
'Bookmarks': {
'Enabled': True|False
},
'SharedView': {
'Enabled': True|False
},
'AmazonQInQuickSight': {
'ExecutiveSummary': {
'Enabled': True|False
}
},
'Schedules': {
'Enabled': True|False
},
'RecentSnapshots': {
'Enabled': True|False
},
'ThresholdAlerts': {
'Enabled': True|False
},
'DashboardCustomizationSummary': {
'Enabled': True|False
}
}
},
'QuickSightConsole': {
'InitialPath': 'string',
'FeatureConfigurations': {
'StatePersistence': {
'Enabled': True|False
},
'SharedView': {
'Enabled': True|False
},
'AmazonQInQuickSight': {
'DataQnA': {
'Enabled': True|False
},
'GenerativeAuthoring': {
'Enabled': True|False
},
'ExecutiveSummary': {
'Enabled': True|False
},
'DataStories': {
'Enabled': True|False
}
},
'Schedules': {
'Enabled': True|False
},
'RecentSnapshots': {
'Enabled': True|False
},
'ThresholdAlerts': {
'Enabled': True|False
},
'DashboardCustomizationSummary': {
'Enabled': True|False
}
}
},
'QSearchBar': {
'InitialTopicId': 'string'
},
'DashboardVisual': {
'InitialDashboardVisualId': {
'DashboardId': 'string',
'SheetId': 'string',
'VisualId': 'string'
}
},
'GenerativeQnA': {
'InitialTopicId': 'string'
},
'QuickChat': {}
},
AllowedDomains=[
'string',
]
)
string
[REQUIRED]
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
integer
How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
string
[REQUIRED]
The Amazon Resource Name for the registered user.
dict
[REQUIRED]
The experience that you want to embed. For registered users, you can embed Quick dashboards, Amazon Quick Sight visuals, the Amazon Quick Sight Q search bar, the Amazon Quick Sight Generative Q&A experience, or the entire Amazon Quick Sight console.
Dashboard (dict) --
The configuration details for providing a dashboard embedding experience.
InitialDashboardId (string) -- [REQUIRED]
The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon Quick Sight renders this dashboard if the user has permissions to view it.
If the user does not have permission to view this dashboard, they see a permissions error message.
FeatureConfigurations (dict) --
The feature configurations of an embbedded Amazon Quick Sight dashboard.
StatePersistence (dict) --
The state persistence settings of an embedded dashboard.
Enabled (boolean) -- [REQUIRED]
Determines if a Quick Sight dashboard's state persistence settings are turned on or off.
Bookmarks (dict) --
The bookmarks configuration for an embedded dashboard in Amazon Quick Sight.
Enabled (boolean) -- [REQUIRED]
A Boolean value that determines whether a user can bookmark an embedded dashboard.
SharedView (dict) --
The shared view settings of an embedded dashboard.
Enabled (boolean) -- [REQUIRED]
The shared view settings of an embedded dashboard.
AmazonQInQuickSight (dict) --
The Amazon Q configurations of an embedded Amazon Quick Sight dashboard.
ExecutiveSummary (dict) --
A generated executive summary of an embedded Quick Sight dashboard.
Enabled (boolean) -- [REQUIRED]
The executive summary settings of an embedded Quick Sight console or dashboard.
Schedules (dict) --
The schedules configuration for an embedded Quick Sight dashboard.
Enabled (boolean) -- [REQUIRED]
The schedules configuration for an embedded Quick Sight dashboard.
RecentSnapshots (dict) --
The recent snapshots configuration for an Quick Sight embedded dashboard
Enabled (boolean) -- [REQUIRED]
The recent snapshots configuration for an embedded Quick Sight dashboard.
ThresholdAlerts (dict) --
The threshold alerts configuration for an Quick Sight embedded dashboard.
Enabled (boolean) -- [REQUIRED]
The threshold alerts configuration for an embedded Quick Sight dashboard.
DashboardCustomizationSummary (dict) --
The dashboard customization summary configuration for an embedded Quick Sight dashboard.
Enabled (boolean) -- [REQUIRED]
The enabled status of the dashboard customization summary configuration for an embedded Quick Sight dashboard.
QuickSightConsole (dict) --
The configuration details for providing each Amazon Quick Sight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon Quick Sight Console in the Amazon Quick User Guide.
Use GenerateEmbedUrlForRegisteredUser where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who accesses an embedded Amazon Quick Sight console needs to belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use the RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon Quick User Guide:
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon Quick Developer Portal.
InitialPath (string) --
The initial URL path for the Amazon Quick Sight console. InitialPath is required.
The entry point URL is constrained to the following paths:
/start
/start/analyses
/start/dashboards
/start/favorites
/dashboards/DashboardId. DashboardId is the actual ID key from the Amazon Quick Sight console URL of the dashboard.
/analyses/AnalysisId. AnalysisId is the actual ID key from the Amazon Quick Sight console URL of the analysis.
FeatureConfigurations (dict) --
The embedding configuration of an embedded Amazon Quick Sight console.
StatePersistence (dict) --
The state persistence configurations of an embedded Amazon Quick Sight console.
Enabled (boolean) -- [REQUIRED]
Determines if a Quick Sight dashboard's state persistence settings are turned on or off.
SharedView (dict) --
The shared view settings of an embedded dashboard.
Enabled (boolean) -- [REQUIRED]
The shared view settings of an embedded dashboard.
AmazonQInQuickSight (dict) --
The Amazon Q configurations of an embedded Amazon Quick Sight console.
DataQnA (dict) --
Adds generative Q&A capabilitiees to an embedded Quick Sight console.
Enabled (boolean) -- [REQUIRED]
The generative Q&A settings of an embedded Quick Sight console.
GenerativeAuthoring (dict) --
Adds the generative BI authoring experience to an embedded Quick Sight console.
Enabled (boolean) -- [REQUIRED]
The generative BI authoring settings of an embedded Quick Sight console.
ExecutiveSummary (dict) --
Adds the executive summaries feature to an embedded Quick Sight console.
Enabled (boolean) -- [REQUIRED]
The executive summary settings of an embedded Quick Sight console or dashboard.
DataStories (dict) --
Adds the data stories feature to an embedded Quick Sight console.
Enabled (boolean) -- [REQUIRED]
The data story settings of an embedded Quick Sight console.
Schedules (dict) --
The schedules configuration for an embedded Quick Sight dashboard.
Enabled (boolean) -- [REQUIRED]
The schedules configuration for an embedded Quick Sight dashboard.
RecentSnapshots (dict) --
The recent snapshots configuration for an embedded Quick Sight dashboard.
Enabled (boolean) -- [REQUIRED]
The recent snapshots configuration for an embedded Quick Sight dashboard.
ThresholdAlerts (dict) --
The threshold alerts configuration for an embedded Quick Sight dashboard.
Enabled (boolean) -- [REQUIRED]
The threshold alerts configuration for an embedded Quick Sight dashboard.
DashboardCustomizationSummary (dict) --
The dashboard customization summary configuration for an embedded Quick Sight console.
Enabled (boolean) -- [REQUIRED]
The enabled status of the dashboard customization summary configuration for an embedded Quick Sight dashboard.
QSearchBar (dict) --
The configuration details for embedding the Q search bar.
For more information about embedding the Q search bar, see Embedding Overview in the Amazon Quick Sight User Guide.
InitialTopicId (string) --
The ID of the legacy Q topic that you want to use as the starting topic in the Q search bar. To locate the topic ID of the topic that you want to use, open the Quick Sight console, navigate to the Topics pane, and choose thre topic that you want to use. The TopicID is located in the URL of the topic that opens. When you select an initial topic, you can specify whether or not readers are allowed to select other topics from the list of available topics.
If you don't specify an initial topic or if you specify a new reader experience topic, a list of all shared legacy topics is shown in the Q bar.
DashboardVisual (dict) --
The type of embedding experience. In this case, Amazon Quick Sight visuals.
InitialDashboardVisualId (dict) -- [REQUIRED]
The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, Amazon Quick Sight renders this visual.
The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.
DashboardId (string) -- [REQUIRED]
The ID of the dashboard that has the visual that you want to embed. The DashboardId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Quick console. You can also get the DashboardId with a ListDashboards API operation.
SheetId (string) -- [REQUIRED]
The ID of the sheet that the has visual that you want to embed. The SheetId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Quick console.
VisualId (string) -- [REQUIRED]
The ID of the visual that you want to embed. The VisualID can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon Quick Sight console.
GenerativeQnA (dict) --
The configuration details for embedding the Generative Q&A experience.
For more information about embedding the Generative Q&A experience, see Embedding Overview in the Amazon Quick Sight User Guide.
InitialTopicId (string) --
The ID of the new Q reader experience topic that you want to make the starting topic in the Generative Q&A experience. You can find a topic ID by navigating to the Topics pane in the Quick application and opening a topic. The ID is in the URL for the topic that you open.
If you don't specify an initial topic or you specify a legacy topic, a list of all shared new reader experience topics is shown in the Generative Q&A experience for your readers. When you select an initial new reader experience topic, you can specify whether or not readers are allowed to select other new reader experience topics from the available ones in the list.
QuickChat (dict) --
The configuration details for embedding the Quick chat agent.
list
The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage Quick Sight menu in the Amazon Quick Sight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.
To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.
(string) --
dict
Response Syntax
{
'EmbedUrl': 'string',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
EmbedUrl (string) --
The embed URL for the Amazon Quick Sight dashboard, visual, Q search bar, Generative Q&A experience, or console.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'ExperienceConfiguration': {'Dashboard': {'FeatureConfigurations': {'DashboardCustomizationSummary': {'Enabled': 'boolean'}}},
'QuickSightConsole': {'FeatureConfigurations': {'DashboardCustomizationSummary': {'Enabled': 'boolean'}}}}}
Generates an embed URL that you can use to embed an Amazon Quick Sight experience in your website. This action can be used for any type of user that is registered in an Amazon Quick Sight account that uses IAM Identity Center for authentication. This API requires identity-enhanced IAM Role sessions for the authenticated user that the API call is being made for.
This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for Amazon Quick Sight with the scope value set to quicksight:read. Before you use this action, make sure that you have configured the relevant Amazon Quick Sight resource and permissions.
See also: AWS API Documentation
Request Syntax
client.generate_embed_url_for_registered_user_with_identity(
AwsAccountId='string',
SessionLifetimeInMinutes=123,
ExperienceConfiguration={
'Dashboard': {
'InitialDashboardId': 'string',
'FeatureConfigurations': {
'StatePersistence': {
'Enabled': True|False
},
'Bookmarks': {
'Enabled': True|False
},
'SharedView': {
'Enabled': True|False
},
'AmazonQInQuickSight': {
'ExecutiveSummary': {
'Enabled': True|False
}
},
'Schedules': {
'Enabled': True|False
},
'RecentSnapshots': {
'Enabled': True|False
},
'ThresholdAlerts': {
'Enabled': True|False
},
'DashboardCustomizationSummary': {
'Enabled': True|False
}
}
},
'QuickSightConsole': {
'InitialPath': 'string',
'FeatureConfigurations': {
'StatePersistence': {
'Enabled': True|False
},
'SharedView': {
'Enabled': True|False
},
'AmazonQInQuickSight': {
'DataQnA': {
'Enabled': True|False
},
'GenerativeAuthoring': {
'Enabled': True|False
},
'ExecutiveSummary': {
'Enabled': True|False
},
'DataStories': {
'Enabled': True|False
}
},
'Schedules': {
'Enabled': True|False
},
'RecentSnapshots': {
'Enabled': True|False
},
'ThresholdAlerts': {
'Enabled': True|False
},
'DashboardCustomizationSummary': {
'Enabled': True|False
}
}
},
'QSearchBar': {
'InitialTopicId': 'string'
},
'DashboardVisual': {
'InitialDashboardVisualId': {
'DashboardId': 'string',
'SheetId': 'string',
'VisualId': 'string'
}
},
'GenerativeQnA': {
'InitialTopicId': 'string'
},
'QuickChat': {}
},
AllowedDomains=[
'string',
]
)
string
[REQUIRED]
The ID of the Amazon Web Services registered user.
integer
The validity of the session in minutes.
dict
[REQUIRED]
The type of experience you want to embed. For registered users, you can embed Quick dashboards or the Amazon Quick Sight console.
Dashboard (dict) --
The configuration details for providing a dashboard embedding experience.
InitialDashboardId (string) -- [REQUIRED]
The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon Quick Sight renders this dashboard if the user has permissions to view it.
If the user does not have permission to view this dashboard, they see a permissions error message.
FeatureConfigurations (dict) --
The feature configurations of an embbedded Amazon Quick Sight dashboard.
StatePersistence (dict) --
The state persistence settings of an embedded dashboard.
Enabled (boolean) -- [REQUIRED]
Determines if a Quick Sight dashboard's state persistence settings are turned on or off.
Bookmarks (dict) --
The bookmarks configuration for an embedded dashboard in Amazon Quick Sight.
Enabled (boolean) -- [REQUIRED]
A Boolean value that determines whether a user can bookmark an embedded dashboard.
SharedView (dict) --
The shared view settings of an embedded dashboard.
Enabled (boolean) -- [REQUIRED]
The shared view settings of an embedded dashboard.
AmazonQInQuickSight (dict) --
The Amazon Q configurations of an embedded Amazon Quick Sight dashboard.
ExecutiveSummary (dict) --
A generated executive summary of an embedded Quick Sight dashboard.
Enabled (boolean) -- [REQUIRED]
The executive summary settings of an embedded Quick Sight console or dashboard.
Schedules (dict) --
The schedules configuration for an embedded Quick Sight dashboard.
Enabled (boolean) -- [REQUIRED]
The schedules configuration for an embedded Quick Sight dashboard.
RecentSnapshots (dict) --
The recent snapshots configuration for an Quick Sight embedded dashboard
Enabled (boolean) -- [REQUIRED]
The recent snapshots configuration for an embedded Quick Sight dashboard.
ThresholdAlerts (dict) --
The threshold alerts configuration for an Quick Sight embedded dashboard.
Enabled (boolean) -- [REQUIRED]
The threshold alerts configuration for an embedded Quick Sight dashboard.
DashboardCustomizationSummary (dict) --
The dashboard customization summary configuration for an embedded Quick Sight dashboard.
Enabled (boolean) -- [REQUIRED]
The enabled status of the dashboard customization summary configuration for an embedded Quick Sight dashboard.
QuickSightConsole (dict) --
The configuration details for providing each Amazon Quick Sight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon Quick Sight Console in the Amazon Quick User Guide.
Use GenerateEmbedUrlForRegisteredUser where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who accesses an embedded Amazon Quick Sight console needs to belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use the RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon Quick User Guide:
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon Quick Developer Portal.
InitialPath (string) --
The initial URL path for the Amazon Quick Sight console. InitialPath is required.
The entry point URL is constrained to the following paths:
/start
/start/analyses
/start/dashboards
/start/favorites
/dashboards/DashboardId. DashboardId is the actual ID key from the Amazon Quick Sight console URL of the dashboard.
/analyses/AnalysisId. AnalysisId is the actual ID key from the Amazon Quick Sight console URL of the analysis.
FeatureConfigurations (dict) --
The embedding configuration of an embedded Amazon Quick Sight console.
StatePersistence (dict) --
The state persistence configurations of an embedded Amazon Quick Sight console.
Enabled (boolean) -- [REQUIRED]
Determines if a Quick Sight dashboard's state persistence settings are turned on or off.
SharedView (dict) --
The shared view settings of an embedded dashboard.
Enabled (boolean) -- [REQUIRED]
The shared view settings of an embedded dashboard.
AmazonQInQuickSight (dict) --
The Amazon Q configurations of an embedded Amazon Quick Sight console.
DataQnA (dict) --
Adds generative Q&A capabilitiees to an embedded Quick Sight console.
Enabled (boolean) -- [REQUIRED]
The generative Q&A settings of an embedded Quick Sight console.
GenerativeAuthoring (dict) --
Adds the generative BI authoring experience to an embedded Quick Sight console.
Enabled (boolean) -- [REQUIRED]
The generative BI authoring settings of an embedded Quick Sight console.
ExecutiveSummary (dict) --
Adds the executive summaries feature to an embedded Quick Sight console.
Enabled (boolean) -- [REQUIRED]
The executive summary settings of an embedded Quick Sight console or dashboard.
DataStories (dict) --
Adds the data stories feature to an embedded Quick Sight console.
Enabled (boolean) -- [REQUIRED]
The data story settings of an embedded Quick Sight console.
Schedules (dict) --
The schedules configuration for an embedded Quick Sight dashboard.
Enabled (boolean) -- [REQUIRED]
The schedules configuration for an embedded Quick Sight dashboard.
RecentSnapshots (dict) --
The recent snapshots configuration for an embedded Quick Sight dashboard.
Enabled (boolean) -- [REQUIRED]
The recent snapshots configuration for an embedded Quick Sight dashboard.
ThresholdAlerts (dict) --
The threshold alerts configuration for an embedded Quick Sight dashboard.
Enabled (boolean) -- [REQUIRED]
The threshold alerts configuration for an embedded Quick Sight dashboard.
DashboardCustomizationSummary (dict) --
The dashboard customization summary configuration for an embedded Quick Sight console.
Enabled (boolean) -- [REQUIRED]
The enabled status of the dashboard customization summary configuration for an embedded Quick Sight dashboard.
QSearchBar (dict) --
The configuration details for embedding the Q search bar.
For more information about embedding the Q search bar, see Embedding Overview in the Amazon Quick Sight User Guide.
InitialTopicId (string) --
The ID of the legacy Q topic that you want to use as the starting topic in the Q search bar. To locate the topic ID of the topic that you want to use, open the Quick Sight console, navigate to the Topics pane, and choose thre topic that you want to use. The TopicID is located in the URL of the topic that opens. When you select an initial topic, you can specify whether or not readers are allowed to select other topics from the list of available topics.
If you don't specify an initial topic or if you specify a new reader experience topic, a list of all shared legacy topics is shown in the Q bar.
DashboardVisual (dict) --
The type of embedding experience. In this case, Amazon Quick Sight visuals.
InitialDashboardVisualId (dict) -- [REQUIRED]
The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, Amazon Quick Sight renders this visual.
The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.
DashboardId (string) -- [REQUIRED]
The ID of the dashboard that has the visual that you want to embed. The DashboardId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Quick console. You can also get the DashboardId with a ListDashboards API operation.
SheetId (string) -- [REQUIRED]
The ID of the sheet that the has visual that you want to embed. The SheetId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Quick console.
VisualId (string) -- [REQUIRED]
The ID of the visual that you want to embed. The VisualID can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon Quick Sight console.
GenerativeQnA (dict) --
The configuration details for embedding the Generative Q&A experience.
For more information about embedding the Generative Q&A experience, see Embedding Overview in the Amazon Quick Sight User Guide.
InitialTopicId (string) --
The ID of the new Q reader experience topic that you want to make the starting topic in the Generative Q&A experience. You can find a topic ID by navigating to the Topics pane in the Quick application and opening a topic. The ID is in the URL for the topic that you open.
If you don't specify an initial topic or you specify a legacy topic, a list of all shared new reader experience topics is shown in the Generative Q&A experience for your readers. When you select an initial new reader experience topic, you can specify whether or not readers are allowed to select other new reader experience topics from the available ones in the list.
QuickChat (dict) --
The configuration details for embedding the Quick chat agent.
list
A list of domains to be allowed to generate the embed URL.
(string) --
dict
Response Syntax
{
'EmbedUrl': 'string',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
EmbedUrl (string) --
The generated embed URL for the registered user.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'CustomPermissionsList': {'Capabilities': {'GenerateAnalyses': 'DENY'}}}
Returns a list of all the custom permissions profiles.
See also: AWS API Documentation
Request Syntax
client.list_custom_permissions(
AwsAccountId='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the custom permissions profiles that you want to list.
integer
The maximum number of results to return.
string
The token for the next set of results, or null if there are no more results.
dict
Response Syntax
{
'Status': 123,
'CustomPermissionsList': [
{
'Arn': 'string',
'CustomPermissionsName': 'string',
'Capabilities': {
'ExportToCsv': 'DENY',
'ExportToExcel': 'DENY',
'ExportToPdf': 'DENY',
'PrintReports': 'DENY',
'CreateAndUpdateThemes': 'DENY',
'AddOrRunAnomalyDetectionForAnalyses': 'DENY',
'ShareAnalyses': 'DENY',
'CreateAndUpdateDatasets': 'DENY',
'ShareDatasets': 'DENY',
'SubscribeDashboardEmailReports': 'DENY',
'CreateAndUpdateDashboardEmailReports': 'DENY',
'ShareDashboards': 'DENY',
'CreateAndUpdateThresholdAlerts': 'DENY',
'RenameSharedFolders': 'DENY',
'CreateSharedFolders': 'DENY',
'CreateAndUpdateDataSources': 'DENY',
'ShareDataSources': 'DENY',
'ViewAccountSPICECapacity': 'DENY',
'CreateSPICEDataset': 'DENY',
'ExportToPdfInScheduledReports': 'DENY',
'ExportToCsvInScheduledReports': 'DENY',
'ExportToExcelInScheduledReports': 'DENY',
'IncludeContentInScheduledReportsEmail': 'DENY',
'Dashboard': 'DENY',
'Analysis': 'DENY',
'Automate': 'DENY',
'Flow': 'DENY',
'PublishWithoutApproval': 'DENY',
'UseBedrockModels': 'DENY',
'PerformFlowUiTask': 'DENY',
'ApproveFlowShareRequests': 'DENY',
'UseAgentWebSearch': 'DENY',
'KnowledgeBase': 'DENY',
'Action': 'DENY',
'GenericHTTPAction': 'DENY',
'CreateAndUpdateGenericHTTPAction': 'DENY',
'ShareGenericHTTPAction': 'DENY',
'UseGenericHTTPAction': 'DENY',
'AsanaAction': 'DENY',
'CreateAndUpdateAsanaAction': 'DENY',
'ShareAsanaAction': 'DENY',
'UseAsanaAction': 'DENY',
'SlackAction': 'DENY',
'CreateAndUpdateSlackAction': 'DENY',
'ShareSlackAction': 'DENY',
'UseSlackAction': 'DENY',
'ServiceNowAction': 'DENY',
'CreateAndUpdateServiceNowAction': 'DENY',
'ShareServiceNowAction': 'DENY',
'UseServiceNowAction': 'DENY',
'SalesforceAction': 'DENY',
'CreateAndUpdateSalesforceAction': 'DENY',
'ShareSalesforceAction': 'DENY',
'UseSalesforceAction': 'DENY',
'MSExchangeAction': 'DENY',
'CreateAndUpdateMSExchangeAction': 'DENY',
'ShareMSExchangeAction': 'DENY',
'UseMSExchangeAction': 'DENY',
'PagerDutyAction': 'DENY',
'CreateAndUpdatePagerDutyAction': 'DENY',
'SharePagerDutyAction': 'DENY',
'UsePagerDutyAction': 'DENY',
'JiraAction': 'DENY',
'CreateAndUpdateJiraAction': 'DENY',
'ShareJiraAction': 'DENY',
'UseJiraAction': 'DENY',
'ConfluenceAction': 'DENY',
'CreateAndUpdateConfluenceAction': 'DENY',
'ShareConfluenceAction': 'DENY',
'UseConfluenceAction': 'DENY',
'OneDriveAction': 'DENY',
'CreateAndUpdateOneDriveAction': 'DENY',
'ShareOneDriveAction': 'DENY',
'UseOneDriveAction': 'DENY',
'SharePointAction': 'DENY',
'CreateAndUpdateSharePointAction': 'DENY',
'ShareSharePointAction': 'DENY',
'UseSharePointAction': 'DENY',
'MSTeamsAction': 'DENY',
'CreateAndUpdateMSTeamsAction': 'DENY',
'ShareMSTeamsAction': 'DENY',
'UseMSTeamsAction': 'DENY',
'GoogleCalendarAction': 'DENY',
'CreateAndUpdateGoogleCalendarAction': 'DENY',
'ShareGoogleCalendarAction': 'DENY',
'UseGoogleCalendarAction': 'DENY',
'ZendeskAction': 'DENY',
'CreateAndUpdateZendeskAction': 'DENY',
'ShareZendeskAction': 'DENY',
'UseZendeskAction': 'DENY',
'SmartsheetAction': 'DENY',
'CreateAndUpdateSmartsheetAction': 'DENY',
'ShareSmartsheetAction': 'DENY',
'UseSmartsheetAction': 'DENY',
'SAPBusinessPartnerAction': 'DENY',
'CreateAndUpdateSAPBusinessPartnerAction': 'DENY',
'ShareSAPBusinessPartnerAction': 'DENY',
'UseSAPBusinessPartnerAction': 'DENY',
'SAPProductMasterDataAction': 'DENY',
'CreateAndUpdateSAPProductMasterDataAction': 'DENY',
'ShareSAPProductMasterDataAction': 'DENY',
'UseSAPProductMasterDataAction': 'DENY',
'SAPPhysicalInventoryAction': 'DENY',
'CreateAndUpdateSAPPhysicalInventoryAction': 'DENY',
'ShareSAPPhysicalInventoryAction': 'DENY',
'UseSAPPhysicalInventoryAction': 'DENY',
'SAPBillOfMaterialAction': 'DENY',
'CreateAndUpdateSAPBillOfMaterialAction': 'DENY',
'ShareSAPBillOfMaterialAction': 'DENY',
'UseSAPBillOfMaterialAction': 'DENY',
'SAPMaterialStockAction': 'DENY',
'CreateAndUpdateSAPMaterialStockAction': 'DENY',
'ShareSAPMaterialStockAction': 'DENY',
'UseSAPMaterialStockAction': 'DENY',
'FactSetAction': 'DENY',
'CreateAndUpdateFactSetAction': 'DENY',
'ShareFactSetAction': 'DENY',
'UseFactSetAction': 'DENY',
'AmazonSThreeAction': 'DENY',
'CreateAndUpdateAmazonSThreeAction': 'DENY',
'ShareAmazonSThreeAction': 'DENY',
'UseAmazonSThreeAction': 'DENY',
'TextractAction': 'DENY',
'CreateAndUpdateTextractAction': 'DENY',
'ShareTextractAction': 'DENY',
'UseTextractAction': 'DENY',
'ComprehendAction': 'DENY',
'CreateAndUpdateComprehendAction': 'DENY',
'ShareComprehendAction': 'DENY',
'UseComprehendAction': 'DENY',
'ComprehendMedicalAction': 'DENY',
'CreateAndUpdateComprehendMedicalAction': 'DENY',
'ShareComprehendMedicalAction': 'DENY',
'UseComprehendMedicalAction': 'DENY',
'AmazonBedrockARSAction': 'DENY',
'CreateAndUpdateAmazonBedrockARSAction': 'DENY',
'ShareAmazonBedrockARSAction': 'DENY',
'UseAmazonBedrockARSAction': 'DENY',
'AmazonBedrockFSAction': 'DENY',
'CreateAndUpdateAmazonBedrockFSAction': 'DENY',
'ShareAmazonBedrockFSAction': 'DENY',
'UseAmazonBedrockFSAction': 'DENY',
'AmazonBedrockKRSAction': 'DENY',
'CreateAndUpdateAmazonBedrockKRSAction': 'DENY',
'ShareAmazonBedrockKRSAction': 'DENY',
'UseAmazonBedrockKRSAction': 'DENY',
'MCPAction': 'DENY',
'CreateAndUpdateMCPAction': 'DENY',
'ShareMCPAction': 'DENY',
'UseMCPAction': 'DENY',
'OpenAPIAction': 'DENY',
'CreateAndUpdateOpenAPIAction': 'DENY',
'ShareOpenAPIAction': 'DENY',
'UseOpenAPIAction': 'DENY',
'SandPGMIAction': 'DENY',
'CreateAndUpdateSandPGMIAction': 'DENY',
'ShareSandPGMIAction': 'DENY',
'UseSandPGMIAction': 'DENY',
'SandPGlobalEnergyAction': 'DENY',
'CreateAndUpdateSandPGlobalEnergyAction': 'DENY',
'ShareSandPGlobalEnergyAction': 'DENY',
'UseSandPGlobalEnergyAction': 'DENY',
'BambooHRAction': 'DENY',
'CreateAndUpdateBambooHRAction': 'DENY',
'ShareBambooHRAction': 'DENY',
'UseBambooHRAction': 'DENY',
'BoxAgentAction': 'DENY',
'CreateAndUpdateBoxAgentAction': 'DENY',
'ShareBoxAgentAction': 'DENY',
'UseBoxAgentAction': 'DENY',
'CanvaAgentAction': 'DENY',
'CreateAndUpdateCanvaAgentAction': 'DENY',
'ShareCanvaAgentAction': 'DENY',
'UseCanvaAgentAction': 'DENY',
'GithubAction': 'DENY',
'CreateAndUpdateGithubAction': 'DENY',
'ShareGithubAction': 'DENY',
'UseGithubAction': 'DENY',
'NotionAction': 'DENY',
'CreateAndUpdateNotionAction': 'DENY',
'ShareNotionAction': 'DENY',
'UseNotionAction': 'DENY',
'LinearAction': 'DENY',
'CreateAndUpdateLinearAction': 'DENY',
'ShareLinearAction': 'DENY',
'UseLinearAction': 'DENY',
'HuggingFaceAction': 'DENY',
'CreateAndUpdateHuggingFaceAction': 'DENY',
'ShareHuggingFaceAction': 'DENY',
'UseHuggingFaceAction': 'DENY',
'MondayAction': 'DENY',
'CreateAndUpdateMondayAction': 'DENY',
'ShareMondayAction': 'DENY',
'UseMondayAction': 'DENY',
'HubspotAction': 'DENY',
'CreateAndUpdateHubspotAction': 'DENY',
'ShareHubspotAction': 'DENY',
'UseHubspotAction': 'DENY',
'IntercomAction': 'DENY',
'CreateAndUpdateIntercomAction': 'DENY',
'ShareIntercomAction': 'DENY',
'UseIntercomAction': 'DENY',
'NewRelicAction': 'DENY',
'CreateAndUpdateNewRelicAction': 'DENY',
'ShareNewRelicAction': 'DENY',
'UseNewRelicAction': 'DENY',
'Topic': 'DENY',
'EditVisualWithQ': 'DENY',
'BuildCalculatedFieldWithQ': 'DENY',
'CreateDashboardExecutiveSummaryWithQ': 'DENY',
'Space': 'DENY',
'CreateSpaces': 'DENY',
'ShareSpaces': 'DENY',
'ChatAgent': 'DENY',
'CreateChatAgents': 'DENY',
'ShareChatAgents': 'DENY',
'Research': 'DENY',
'SelfUpgradeUserRole': 'DENY',
'Extension': 'DENY',
'ManageSharedFolders': 'DENY',
'GenerateAnalyses': 'DENY'
}
},
],
'NextToken': 'string',
'RequestId': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
CustomPermissionsList (list) --
A list of custom permissions profiles.
(dict) --
The custom permissions profile.
Arn (string) --
The Amazon Resource Name (ARN) of the custom permissions profile.
CustomPermissionsName (string) --
The name of the custom permissions profile.
Capabilities (dict) --
A set of actions in the custom permissions profile.
ExportToCsv (string) --
The ability to export to CSV files from the UI.
ExportToExcel (string) --
The ability to export to Excel files from the UI.
ExportToPdf (string) --
The ability to export to PDF files from the UI.
PrintReports (string) --
The ability to print reports.
CreateAndUpdateThemes (string) --
The ability to export to Create and Update themes.
AddOrRunAnomalyDetectionForAnalyses (string) --
The ability to add or run anomaly detection.
ShareAnalyses (string) --
The ability to share analyses.
CreateAndUpdateDatasets (string) --
The ability to create and update datasets.
ShareDatasets (string) --
The ability to share datasets.
SubscribeDashboardEmailReports (string) --
The ability to subscribe to email reports.
CreateAndUpdateDashboardEmailReports (string) --
The ability to create and update email reports.
ShareDashboards (string) --
The ability to share dashboards.
CreateAndUpdateThresholdAlerts (string) --
The ability to create and update threshold alerts.
RenameSharedFolders (string) --
The ability to rename shared folders.
CreateSharedFolders (string) --
The ability to create shared folders.
CreateAndUpdateDataSources (string) --
The ability to create and update data sources.
ShareDataSources (string) --
The ability to share data sources.
ViewAccountSPICECapacity (string) --
The ability to view account SPICE capacity.
CreateSPICEDataset (string) --
The ability to create a SPICE dataset.
ExportToPdfInScheduledReports (string) --
The ability to export to PDF files in scheduled email reports.
ExportToCsvInScheduledReports (string) --
The ability to export to CSV files in scheduled email reports.
ExportToExcelInScheduledReports (string) --
The ability to export to Excel files in scheduled email reports.
IncludeContentInScheduledReportsEmail (string) --
The ability to include content in scheduled email reports.
Dashboard (string) --
The ability to perform dashboard-related actions.
Analysis (string) --
The ability to perform analysis-related actions.
Automate (string) --
The ability to perform automate-related actions.
Flow (string) --
The ability to perform flow-related actions.
PublishWithoutApproval (string) --
The ability to enable approvals for flow share.
UseBedrockModels (string) --
The ability to use Bedrock models for general knowledge step in flows.
PerformFlowUiTask (string) --
The ability to use UI Agent step to perform tasks on public websites.
ApproveFlowShareRequests (string) --
The ability to review and approve sharing requests of Flows.
UseAgentWebSearch (string) --
The ability to use internet to enhance results in Chat Agents, Flows, and Quick Research. Web search queries will be processed securely in an Amazon Web Services region us-east-1.
KnowledgeBase (string) --
The ability to use knowledge bases to specify content from external applications.
Action (string) --
The ability to perform actions in external services through Action connectors. Actions allow users to interact with third-party systems.
GenericHTTPAction (string) --
The ability to perform actions using REST API connection connectors.
CreateAndUpdateGenericHTTPAction (string) --
The ability to create and update REST API connection actions.
ShareGenericHTTPAction (string) --
The ability to share REST API connection actions.
UseGenericHTTPAction (string) --
The ability to use REST API connection actions.
AsanaAction (string) --
The ability to perform actions using Asana connectors.
CreateAndUpdateAsanaAction (string) --
The ability to create and update Asana actions.
ShareAsanaAction (string) --
The ability to share Asana actions.
UseAsanaAction (string) --
The ability to use Asana actions.
SlackAction (string) --
The ability to perform actions using Slack connectors.
CreateAndUpdateSlackAction (string) --
The ability to create and update Slack actions.
ShareSlackAction (string) --
The ability to share Slack actions.
UseSlackAction (string) --
The ability to use Slack actions.
ServiceNowAction (string) --
The ability to perform actions using ServiceNow connectors.
CreateAndUpdateServiceNowAction (string) --
The ability to create and update ServiceNow actions.
ShareServiceNowAction (string) --
The ability to share ServiceNow actions.
UseServiceNowAction (string) --
The ability to use ServiceNow actions.
SalesforceAction (string) --
The ability to perform actions using Salesforce connectors.
CreateAndUpdateSalesforceAction (string) --
The ability to create and update Salesforce actions.
ShareSalesforceAction (string) --
The ability to share Salesforce actions.
UseSalesforceAction (string) --
The ability to use Salesforce actions.
MSExchangeAction (string) --
The ability to perform actions using Microsoft Outlook connectors.
CreateAndUpdateMSExchangeAction (string) --
The ability to create and update Microsoft Outlook actions.
ShareMSExchangeAction (string) --
The ability to share Microsoft Outlook actions.
UseMSExchangeAction (string) --
The ability to use Microsoft Outlook actions.
PagerDutyAction (string) --
The ability to perform actions using PagerDuty Advance connectors.
CreateAndUpdatePagerDutyAction (string) --
The ability to create and update PagerDuty Advance actions.
SharePagerDutyAction (string) --
The ability to share PagerDuty Advance actions.
UsePagerDutyAction (string) --
The ability to use PagerDuty Advance actions.
JiraAction (string) --
The ability to perform actions using Jira connectors.
CreateAndUpdateJiraAction (string) --
The ability to create and update Jira actions.
ShareJiraAction (string) --
The ability to share Jira actions.
UseJiraAction (string) --
The ability to use Jira actions.
ConfluenceAction (string) --
The ability to perform actions using Atlassian Confluence Cloud connectors.
CreateAndUpdateConfluenceAction (string) --
The ability to create and update Atlassian Confluence Cloud actions.
ShareConfluenceAction (string) --
The ability to share Atlassian Confluence Cloud actions.
UseConfluenceAction (string) --
The ability to use Atlassian Confluence Cloud actions.
OneDriveAction (string) --
The ability to perform actions using Microsoft OneDrive connectors.
CreateAndUpdateOneDriveAction (string) --
The ability to create and update Microsoft OneDrive actions.
ShareOneDriveAction (string) --
The ability to share Microsoft OneDrive actions.
UseOneDriveAction (string) --
The ability to use Microsoft OneDrive actions.
SharePointAction (string) --
The ability to perform actions using Microsoft SharePoint Online connectors.
CreateAndUpdateSharePointAction (string) --
The ability to create and update Microsoft SharePoint Online actions.
ShareSharePointAction (string) --
The ability to share Microsoft SharePoint Online actions.
UseSharePointAction (string) --
The ability to use Microsoft SharePoint Online actions.
MSTeamsAction (string) --
The ability to perform actions using Microsoft Teams connectors.
CreateAndUpdateMSTeamsAction (string) --
The ability to create and update Microsoft Teams actions.
ShareMSTeamsAction (string) --
The ability to share Microsoft Teams actions.
UseMSTeamsAction (string) --
The ability to use Microsoft Teams actions.
GoogleCalendarAction (string) --
The ability to perform actions using Google Calendar connectors.
CreateAndUpdateGoogleCalendarAction (string) --
The ability to create and update Google Calendar actions.
ShareGoogleCalendarAction (string) --
The ability to share Google Calendar actions.
UseGoogleCalendarAction (string) --
The ability to use Google Calendar actions.
ZendeskAction (string) --
The ability to perform actions using Zendesk connectors.
CreateAndUpdateZendeskAction (string) --
The ability to create and update Zendesk actions.
ShareZendeskAction (string) --
The ability to share Zendesk actions.
UseZendeskAction (string) --
The ability to use Zendesk actions.
SmartsheetAction (string) --
The ability to perform actions using Smartsheet connectors.
CreateAndUpdateSmartsheetAction (string) --
The ability to create and update Smartsheet actions.
ShareSmartsheetAction (string) --
The ability to share Smartsheet actions.
UseSmartsheetAction (string) --
The ability to use Smartsheet actions.
SAPBusinessPartnerAction (string) --
The ability to perform actions using SAP Business Partner connectors.
CreateAndUpdateSAPBusinessPartnerAction (string) --
The ability to create and update SAP Business Partner actions.
ShareSAPBusinessPartnerAction (string) --
The ability to share SAP Business Partner actions.
UseSAPBusinessPartnerAction (string) --
The ability to use SAP Business Partner actions.
SAPProductMasterDataAction (string) --
The ability to perform actions using SAP Product Master connectors.
CreateAndUpdateSAPProductMasterDataAction (string) --
The ability to create and update SAP Product Master actions.
ShareSAPProductMasterDataAction (string) --
The ability to share SAP Product Master actions.
UseSAPProductMasterDataAction (string) --
The ability to use SAP Product Master actions.
SAPPhysicalInventoryAction (string) --
The ability to perform actions using SAP Physical Inventory connectors.
CreateAndUpdateSAPPhysicalInventoryAction (string) --
The ability to create and update SAP Physical Inventory actions.
ShareSAPPhysicalInventoryAction (string) --
The ability to share SAP Physical Inventory actions.
UseSAPPhysicalInventoryAction (string) --
The ability to use SAP Physical Inventory actions.
SAPBillOfMaterialAction (string) --
The ability to perform actions using SAP Bill of Materials connectors.
CreateAndUpdateSAPBillOfMaterialAction (string) --
The ability to create and update SAP Bill of Materials actions.
ShareSAPBillOfMaterialAction (string) --
The ability to share SAP Bill of Materials actions.
UseSAPBillOfMaterialAction (string) --
The ability to use SAP Bill of Materials actions.
SAPMaterialStockAction (string) --
The ability to perform actions using SAP Material Stock connectors.
CreateAndUpdateSAPMaterialStockAction (string) --
The ability to create and update SAP Material Stock actions.
ShareSAPMaterialStockAction (string) --
The ability to share SAP Material Stock actions.
UseSAPMaterialStockAction (string) --
The ability to use SAP Material Stock actions.
FactSetAction (string) --
The ability to perform actions using FactSet connectors.
CreateAndUpdateFactSetAction (string) --
The ability to create and update FactSet actions.
ShareFactSetAction (string) --
The ability to share FactSet actions.
UseFactSetAction (string) --
The ability to use FactSet actions.
AmazonSThreeAction (string) --
The ability to perform actions using Amazon S3 connectors.
CreateAndUpdateAmazonSThreeAction (string) --
The ability to create and update Amazon S3 actions.
ShareAmazonSThreeAction (string) --
The ability to share Amazon S3 actions.
UseAmazonSThreeAction (string) --
The ability to use Amazon S3 actions.
TextractAction (string) --
The ability to perform actions using Textract connectors.
CreateAndUpdateTextractAction (string) --
The ability to create and update Textract actions.
ShareTextractAction (string) --
The ability to share Textract actions.
UseTextractAction (string) --
The ability to use Textract actions.
ComprehendAction (string) --
The ability to perform actions using Comprehend connectors.
CreateAndUpdateComprehendAction (string) --
The ability to create and update Comprehend actions.
ShareComprehendAction (string) --
The ability to share Comprehend actions.
UseComprehendAction (string) --
The ability to use Comprehend actions.
ComprehendMedicalAction (string) --
The ability to perform actions using Comprehend Medical connectors.
CreateAndUpdateComprehendMedicalAction (string) --
The ability to create and update Comprehend Medical actions.
ShareComprehendMedicalAction (string) --
The ability to share Comprehend Medical actions.
UseComprehendMedicalAction (string) --
The ability to use Comprehend Medical actions.
AmazonBedrockARSAction (string) --
The ability to perform actions using Bedrock Agent connectors.
CreateAndUpdateAmazonBedrockARSAction (string) --
The ability to create and update Bedrock Agent actions.
ShareAmazonBedrockARSAction (string) --
The ability to share Bedrock Agent actions.
UseAmazonBedrockARSAction (string) --
The ability to use Bedrock Agent actions.
AmazonBedrockFSAction (string) --
The ability to perform actions using Bedrock Runtime connectors.
CreateAndUpdateAmazonBedrockFSAction (string) --
The ability to create and update Bedrock Runtime actions.
ShareAmazonBedrockFSAction (string) --
The ability to share Bedrock Runtime actions.
UseAmazonBedrockFSAction (string) --
The ability to use Bedrock Runtime actions.
AmazonBedrockKRSAction (string) --
The ability to perform actions using Bedrock Data Automation Runtime connectors.
CreateAndUpdateAmazonBedrockKRSAction (string) --
The ability to create and update Bedrock Data Automation Runtime actions.
ShareAmazonBedrockKRSAction (string) --
The ability to share Bedrock Data Automation Runtime actions.
UseAmazonBedrockKRSAction (string) --
The ability to use Bedrock Data Automation Runtime actions.
MCPAction (string) --
The ability to perform actions using Model Context Protocol connectors.
CreateAndUpdateMCPAction (string) --
The ability to create and update Model Context Protocol actions.
ShareMCPAction (string) --
The ability to share Model Context Protocol actions.
UseMCPAction (string) --
The ability to use Model Context Protocol actions.
OpenAPIAction (string) --
The ability to perform actions using OpenAPI Specification connectors.
CreateAndUpdateOpenAPIAction (string) --
The ability to create and update OpenAPI Specification actions.
ShareOpenAPIAction (string) --
The ability to share OpenAPI Specification actions.
UseOpenAPIAction (string) --
The ability to use OpenAPI Specification actions.
SandPGMIAction (string) --
The ability to perform actions using S&P Global Market Intelligence connectors.
CreateAndUpdateSandPGMIAction (string) --
The ability to create and update S&P Global Market Intelligence actions.
ShareSandPGMIAction (string) --
The ability to share S&P Global Market Intelligence actions.
UseSandPGMIAction (string) --
The ability to use S&P Global Market Intelligence actions.
SandPGlobalEnergyAction (string) --
The ability to perform actions using S&P Global Energy connectors.
CreateAndUpdateSandPGlobalEnergyAction (string) --
The ability to create and update S&P Global Energy actions.
ShareSandPGlobalEnergyAction (string) --
The ability to share S&P Global Energy actions.
UseSandPGlobalEnergyAction (string) --
The ability to use S&P Global Energy actions.
BambooHRAction (string) --
The ability to perform actions using BambooHR connectors.
CreateAndUpdateBambooHRAction (string) --
The ability to create and update BambooHR actions.
ShareBambooHRAction (string) --
The ability to share BambooHR actions.
UseBambooHRAction (string) --
The ability to use BambooHR actions.
BoxAgentAction (string) --
The ability to perform actions using Box Agent connectors.
CreateAndUpdateBoxAgentAction (string) --
The ability to create and update Box Agent actions.
ShareBoxAgentAction (string) --
The ability to share Box Agent actions.
UseBoxAgentAction (string) --
The ability to use Box Agent actions.
CanvaAgentAction (string) --
The ability to perform actions using Canva Agent connectors.
CreateAndUpdateCanvaAgentAction (string) --
The ability to create and update Canva Agent actions.
ShareCanvaAgentAction (string) --
The ability to share Canva Agent actions.
UseCanvaAgentAction (string) --
The ability to use Canva Agent actions.
GithubAction (string) --
The ability to perform actions using GitHub connectors.
CreateAndUpdateGithubAction (string) --
The ability to create and update GitHub actions.
ShareGithubAction (string) --
The ability to share GitHub actions.
UseGithubAction (string) --
The ability to use GitHub actions.
NotionAction (string) --
The ability to perform actions using Notion connectors.
CreateAndUpdateNotionAction (string) --
The ability to create and update Notion actions.
ShareNotionAction (string) --
The ability to share Notion actions.
UseNotionAction (string) --
The ability to use Notion actions.
LinearAction (string) --
The ability to perform actions using Linear connectors.
CreateAndUpdateLinearAction (string) --
The ability to create and update Linear actions.
ShareLinearAction (string) --
The ability to share Linear actions.
UseLinearAction (string) --
The ability to use Linear actions.
HuggingFaceAction (string) --
The ability to perform actions using HuggingFace connectors.
CreateAndUpdateHuggingFaceAction (string) --
The ability to create and update HuggingFace actions.
ShareHuggingFaceAction (string) --
The ability to share HuggingFace actions.
UseHuggingFaceAction (string) --
The ability to use HuggingFace actions.
MondayAction (string) --
The ability to perform actions using Monday connectors.
CreateAndUpdateMondayAction (string) --
The ability to create and update Monday actions.
ShareMondayAction (string) --
The ability to share Monday actions.
UseMondayAction (string) --
The ability to use Monday actions.
HubspotAction (string) --
The ability to perform actions using Hubspot connectors.
CreateAndUpdateHubspotAction (string) --
The ability to create and update Hubspot actions.
ShareHubspotAction (string) --
The ability to share Hubspot actions.
UseHubspotAction (string) --
The ability to use Hubspot actions.
IntercomAction (string) --
The ability to perform actions using Intercom connectors.
CreateAndUpdateIntercomAction (string) --
The ability to create and update Intercom actions.
ShareIntercomAction (string) --
The ability to share Intercom actions.
UseIntercomAction (string) --
The ability to use Intercom actions.
NewRelicAction (string) --
The ability to perform actions using New Relic connectors.
CreateAndUpdateNewRelicAction (string) --
The ability to create and update New Relic actions.
ShareNewRelicAction (string) --
The ability to share New Relic actions.
UseNewRelicAction (string) --
The ability to use New Relic actions.
Topic (string) --
The ability to perform Topic-related actions.
EditVisualWithQ (string) --
The ability to Edit Visual with AI
BuildCalculatedFieldWithQ (string) --
The ability to Build Calculation with AI
CreateDashboardExecutiveSummaryWithQ (string) --
The ability to Create Executive Summary
Space (string) --
The ability to perform space-related actions.
CreateSpaces (string) --
The ability to create spaces.
ShareSpaces (string) --
The ability to share spaces with other users and groups.
ChatAgent (string) --
The ability to perform chat-related actions.
CreateChatAgents (string) --
The ability to create chat agents.
ShareChatAgents (string) --
The ability to share chat agents with other users and groups.
Research (string) --
The ability to perform research-related actions.
SelfUpgradeUserRole (string) --
The ability to enable users to upgrade their user role.
Extension (string) --
The ability to perform Extension-related actions.
ManageSharedFolders (string) --
The ability to create, update, delete and view shared folders (both restricted and unrestricted), ability to add any asset to shared folders, and ability to share the folders.
Note: This does not prevent inheriting access to assets that others share with them through folder membership.
GenerateAnalyses (string) --
The ability to generate analysis using AI
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.
{'DataSources': {'AlternateDataSourceParameters': {'AthenaParameters': {'ConsumerAccountRoleArn': 'string'},
'S3TablesParameters': {'TableBucketArn': 'string'}},
'DataSourceParameters': {'AthenaParameters': {'ConsumerAccountRoleArn': 'string'},
'S3TablesParameters': {'TableBucketArn': 'string'}},
'Type': {'S3_TABLES'}}}
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'|'S3_TABLES'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY'|'GOOGLESHEETS'|'GOOGLE_DRIVE'|'CONFLUENCE'|'SHAREPOINT'|'ONE_DRIVE'|'WEB_CRAWLER'|'S3_KNOWLEDGE_BASE'|'QBUSINESS',
'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',
'ConsumerAccountRoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'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',
'UseServiceName': True|False
},
'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
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': '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',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
}
},
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string',
'ConsumerAccountRoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'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',
'UseServiceName': True|False
},
'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
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': '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',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': '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 Quick Sight 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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
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 Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight 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 Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight 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, Quick Sight 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.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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 Quick Sight.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base 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 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) --
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
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.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
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.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
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.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) --
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) --
The host name of the Impala data source.
Port (integer) --
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) --
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) --
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) --
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q Business application.
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 Quick Sight 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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
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 Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight 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 Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight 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, Quick Sight 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.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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 Quick Sight.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base 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 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) --
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
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.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
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.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
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.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) --
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) --
The host name of the Impala data source.
Port (integer) --
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) --
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) --
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) --
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q Business application.
VpcConnectionProperties (dict) --
The VPC connection information. You need to use this parameter only when you want Quick Sight 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 Quick Sight 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.
{'DataSourceSummaries': {'Type': {'S3_TABLES'}}}
Use the SearchDataSources operation to search for data sources that belong to an account.
See also: AWS API Documentation
Request Syntax
client.search_data_sources(
AwsAccountId='string',
Filters=[
{
'Operator': 'StringEquals'|'StringLike',
'Name': 'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'DATASOURCE_NAME',
'Value': 'string'
},
],
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The Amazon Web Services account ID.
list
[REQUIRED]
The filters to apply to the search.
(dict) --
A filter that you apply when searching for data sources.
Operator (string) -- [REQUIRED]
The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".
If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose data sources you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
If you set the value to "StringLike", you need to provide the name of the data sources you are searching for. For example, "Name":"DATASOURCE_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DATASOURCE_NAME.
Name (string) -- [REQUIRED]
The name of the value that you want to use as a filter, for example, "Name": "DIRECT_QUICKSIGHT_OWNER".
Valid values are defined as follows:
DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners or viewers of the data sources are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners if the data source are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any data sources with that ARN listed as the only owner of the data source are returned. Implicit permissions from folders or groups are not considered.
DATASOURCE_NAME: Any data sources whose names have a substring match to the provided value are returned.
Value (string) -- [REQUIRED]
The value of the named item, for example DIRECT_QUICKSIGHT_OWNER, that you want to use as a filter, for example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
string
A pagination token that can be used in a subsequent request.
integer
The maximum number of results to be returned per request.
dict
Response Syntax
{
'DataSourceSummaries': [
{
'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'|'S3_TABLES'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY'|'GOOGLESHEETS'|'GOOGLE_DRIVE'|'CONFLUENCE'|'SHAREPOINT'|'ONE_DRIVE'|'WEB_CRAWLER'|'S3_KNOWLEDGE_BASE'|'QBUSINESS',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
DataSourceSummaries (list) --
A DataSourceSummaries object that returns a summary of a data source.
(dict) --
A DataSourceSummary object that returns a summary of a data source.
Arn (string) --
The arn of the datasource.
DataSourceId (string) --
The unique ID of the data source.
Name (string) --
The name of the data source.
Type (string) --
The type of the data source.
CreatedTime (datetime) --
The date and time that the data source was created. This value is expressed in MM-DD-YYYY HH:MM:SS format.
LastUpdatedTime (datetime) --
The date and time the data source was last updated. This value is expressed in MM-DD-YYYY HH:MM:SS format.
NextToken (string) --
A pagination token that can be used in a subsequent request.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'OverrideParameters': {'DataSources': {'DataSourceParameters': {'AthenaParameters': {'ConsumerAccountRoleArn': 'string'},
'S3TablesParameters': {'TableBucketArn': 'string'}}}}}
Starts an Asset Bundle import job.
An Asset Bundle import job imports specified Amazon Quick Sight assets into an Amazon Quick Sight 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 Quick Sight account. Each Amazon Quick Sight 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',
'ConsumerAccountRoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'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',
'UseServiceName': True|False
},
'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
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': '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',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
}
},
'VpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'SslProperties': {
'DisableSsl': True|False
},
'Credentials': {
'CredentialPair': {
'Username': 'string',
'Password': 'string'
},
'SecretArn': 'string'
}
},
],
'DataSets': [
{
'DataSetId': 'string',
'Name': 'string',
'DataSetRefreshProperties': {
'RefreshConfiguration': {
'IncrementalRefresh': {
'LookbackWindow': {
'ColumnName': 'string',
'Size': 123,
'SizeUnit': 'HOUR'|'DAY'|'WEEK'
}
}
},
'FailureConfiguration': {
'EmailAlert': {
'AlertStatus': 'ENABLED'|'DISABLED'
}
}
}
},
],
'Themes': [
{
'ThemeId': 'string',
'Name': 'string'
},
],
'Analyses': [
{
'AnalysisId': 'string',
'Name': 'string'
},
],
'Dashboards': [
{
'DashboardId': 'string',
'Name': 'string'
},
],
'Folders': [
{
'FolderId': 'string',
'Name': 'string',
'ParentFolderArn': 'string'
},
]
},
FailureAction='DO_NOTHING'|'ROLLBACK',
OverridePermissions={
'DataSources': [
{
'DataSourceIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'DataSets': [
{
'DataSetIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Themes': [
{
'ThemeIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Analyses': [
{
'AnalysisIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Dashboards': [
{
'DashboardIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
},
'LinkSharingConfiguration': {
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
}
},
],
'Folders': [
{
'FolderIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
]
},
OverrideTags={
'VPCConnections': [
{
'VPCConnectionIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'DataSources': [
{
'DataSourceIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'DataSets': [
{
'DataSetIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Themes': [
{
'ThemeIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Analyses': [
{
'AnalysisIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Dashboards': [
{
'DashboardIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Folders': [
{
'FolderIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
},
OverrideValidationStrategy={
'StrictModeForAllResources': True|False
}
)
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 the size of the file that you want to upload is more than 20 MB, add the file to your Amazon S3 bucket and use S3Uri of the file for this operation.
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 1 GB.
dict
Optional overrides that are 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 Quick Sight 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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
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 Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight 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 Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight 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, Quick Sight 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.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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 Quick Sight.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base 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 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) -- [REQUIRED]
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
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.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
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.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
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.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) -- [REQUIRED]
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) -- [REQUIRED]
The host name of the Impala data source.
Port (integer) -- [REQUIRED]
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) -- [REQUIRED]
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) -- [REQUIRED]
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Q Business application.
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 Quick Sight 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.
DataSetRefreshProperties (dict) --
The refresh properties of a dataset.
RefreshConfiguration (dict) --
The refresh configuration for a dataset.
IncrementalRefresh (dict) -- [REQUIRED]
The incremental refresh for the dataset.
LookbackWindow (dict) -- [REQUIRED]
The lookback window setup for an incremental refresh configuration.
ColumnName (string) -- [REQUIRED]
The name of the lookback window column.
Size (integer) -- [REQUIRED]
The lookback window column size.
SizeUnit (string) -- [REQUIRED]
The size unit that is used for the lookback window column. Valid values for this structure are HOUR, DAY, and WEEK.
FailureConfiguration (dict) --
The failure configuration for a dataset.
EmailAlert (dict) --
The email alert configuration for a dataset refresh failure.
AlertStatus (string) --
The status value that determines if email alerts are sent.
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.
Folders (list) --
A list of overrides for any Folder resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single folder that is being imported.
FolderId (string) -- [REQUIRED]
The ID of the folder that you want to apply overrides to.
Name (string) --
A new name for the folder.
ParentFolderArn (string) --
A new parent folder arn. This change can only be applied if the import creates a brand new folder. Existing folders cannot be moved.
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 Quick Sight account in an inconsistent state.
dict
Optional permission overrides that are applied to the resource configuration before import.
DataSources (list) --
A list of permissions overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of data source IDs.
DataSourceIds (list) -- [REQUIRED]
A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.
(string) --
Permissions (dict) -- [REQUIRED]
A list of permissions for the data source that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
DataSets (list) --
A list of permissions overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of dataset IDs.
DataSetIds (list) -- [REQUIRED]
A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.
(string) --
Permissions (dict) -- [REQUIRED]
A list of permissions for the datasets that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
Themes (list) --
A list of permissions overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of theme IDs.
ThemeIds (list) -- [REQUIRED]
A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.
(string) --
Permissions (dict) -- [REQUIRED]
A list of permissions for the themes that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
Analyses (list) --
A list of permissions overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of analysis IDs.
AnalysisIds (list) -- [REQUIRED]
A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.
(string) --
Permissions (dict) -- [REQUIRED]
A list of permissions for the analyses that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
Dashboards (list) --
A list of permissions overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of dashboard IDs.
DashboardIds (list) -- [REQUIRED]
A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the dashboards that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
LinkSharingConfiguration (dict) --
A structure that contains the link sharing configurations that you want to apply overrides to.
Permissions (dict) --
A list of link sharing permissions for the dashboards that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
Folders (list) --
A list of permissions for the folders that you want to apply overrides to.
(dict) --
An object that contains a list of permissions to be applied to a list of folder IDs.
FolderIds (list) -- [REQUIRED]
A list of folder IDs that you want to apply overrides to. You can use * to override all folders in this asset bundle.
(string) --
Permissions (dict) --
A structure that contains the permissions for the resource that you want to override in an asset bundle import job.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
dict
Optional tag overrides that are applied to the resource configuration before import.
VPCConnections (list) --
A list of tag overrides for any VPCConnection resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of VPC connection IDs.
VPCConnectionIds (list) -- [REQUIRED]
A list of VPC connection IDs that you want to apply overrides to. You can use * to override all VPC connections in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the VPC connections that you want to apply overrides to.
(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.
DataSources (list) --
A list of tag overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of data source IDs.
DataSourceIds (list) -- [REQUIRED]
A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the data source that you want to apply overrides to.
(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.
DataSets (list) --
A list of tag overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of dataset IDs.
DataSetIds (list) -- [REQUIRED]
A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the datasets that you want to apply overrides to.
(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.
Themes (list) --
A list of tag overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of theme IDs.
ThemeIds (list) -- [REQUIRED]
A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the themes that you want to apply overrides to.
(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.
Analyses (list) --
A list of tag overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of analysis IDs.
AnalysisIds (list) -- [REQUIRED]
A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the analyses that you want to apply overrides to.
(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.
Dashboards (list) --
A list of tag overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of dashboard IDs.
DashboardIds (list) -- [REQUIRED]
A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the dashboards that you want to apply overrides to.
(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.
Folders (list) --
A list of tag overrides for any Folder resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of folder IDs.
FolderIds (list) -- [REQUIRED]
A list of folder IDs that you want to apply overrides to. You can use * to override all folders in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the folders that you want to apply overrides to.
(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
An optional validation strategy override for all analyses and dashboards that is applied to the resource configuration before import.
StrictModeForAllResources (boolean) --
A Boolean value that indicates whether to import all analyses and dashboards under strict or lenient mode.
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': {'CategoryFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'NestedFilter': {'InnerFilter': {'CategoryInnerFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}}}},
'NumericEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'NumericRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'RelativeDatesFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'TimeEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'TimeRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'TopBottomFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}}}},
'Sheets': {'FilterControls': {'Dropdown': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'List': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}},
'ParameterControls': {'Dropdown': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'List': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}}}
Updates an analysis in Amazon Quick Sight
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.
{'Capabilities': {'GenerateAnalyses': 'DENY'}}
Updates a custom permissions profile.
See also: AWS API Documentation
Request Syntax
client.update_custom_permissions(
AwsAccountId='string',
CustomPermissionsName='string',
Capabilities={
'ExportToCsv': 'DENY',
'ExportToExcel': 'DENY',
'ExportToPdf': 'DENY',
'PrintReports': 'DENY',
'CreateAndUpdateThemes': 'DENY',
'AddOrRunAnomalyDetectionForAnalyses': 'DENY',
'ShareAnalyses': 'DENY',
'CreateAndUpdateDatasets': 'DENY',
'ShareDatasets': 'DENY',
'SubscribeDashboardEmailReports': 'DENY',
'CreateAndUpdateDashboardEmailReports': 'DENY',
'ShareDashboards': 'DENY',
'CreateAndUpdateThresholdAlerts': 'DENY',
'RenameSharedFolders': 'DENY',
'CreateSharedFolders': 'DENY',
'CreateAndUpdateDataSources': 'DENY',
'ShareDataSources': 'DENY',
'ViewAccountSPICECapacity': 'DENY',
'CreateSPICEDataset': 'DENY',
'ExportToPdfInScheduledReports': 'DENY',
'ExportToCsvInScheduledReports': 'DENY',
'ExportToExcelInScheduledReports': 'DENY',
'IncludeContentInScheduledReportsEmail': 'DENY',
'Dashboard': 'DENY',
'Analysis': 'DENY',
'Automate': 'DENY',
'Flow': 'DENY',
'PublishWithoutApproval': 'DENY',
'UseBedrockModels': 'DENY',
'PerformFlowUiTask': 'DENY',
'ApproveFlowShareRequests': 'DENY',
'UseAgentWebSearch': 'DENY',
'KnowledgeBase': 'DENY',
'Action': 'DENY',
'GenericHTTPAction': 'DENY',
'CreateAndUpdateGenericHTTPAction': 'DENY',
'ShareGenericHTTPAction': 'DENY',
'UseGenericHTTPAction': 'DENY',
'AsanaAction': 'DENY',
'CreateAndUpdateAsanaAction': 'DENY',
'ShareAsanaAction': 'DENY',
'UseAsanaAction': 'DENY',
'SlackAction': 'DENY',
'CreateAndUpdateSlackAction': 'DENY',
'ShareSlackAction': 'DENY',
'UseSlackAction': 'DENY',
'ServiceNowAction': 'DENY',
'CreateAndUpdateServiceNowAction': 'DENY',
'ShareServiceNowAction': 'DENY',
'UseServiceNowAction': 'DENY',
'SalesforceAction': 'DENY',
'CreateAndUpdateSalesforceAction': 'DENY',
'ShareSalesforceAction': 'DENY',
'UseSalesforceAction': 'DENY',
'MSExchangeAction': 'DENY',
'CreateAndUpdateMSExchangeAction': 'DENY',
'ShareMSExchangeAction': 'DENY',
'UseMSExchangeAction': 'DENY',
'PagerDutyAction': 'DENY',
'CreateAndUpdatePagerDutyAction': 'DENY',
'SharePagerDutyAction': 'DENY',
'UsePagerDutyAction': 'DENY',
'JiraAction': 'DENY',
'CreateAndUpdateJiraAction': 'DENY',
'ShareJiraAction': 'DENY',
'UseJiraAction': 'DENY',
'ConfluenceAction': 'DENY',
'CreateAndUpdateConfluenceAction': 'DENY',
'ShareConfluenceAction': 'DENY',
'UseConfluenceAction': 'DENY',
'OneDriveAction': 'DENY',
'CreateAndUpdateOneDriveAction': 'DENY',
'ShareOneDriveAction': 'DENY',
'UseOneDriveAction': 'DENY',
'SharePointAction': 'DENY',
'CreateAndUpdateSharePointAction': 'DENY',
'ShareSharePointAction': 'DENY',
'UseSharePointAction': 'DENY',
'MSTeamsAction': 'DENY',
'CreateAndUpdateMSTeamsAction': 'DENY',
'ShareMSTeamsAction': 'DENY',
'UseMSTeamsAction': 'DENY',
'GoogleCalendarAction': 'DENY',
'CreateAndUpdateGoogleCalendarAction': 'DENY',
'ShareGoogleCalendarAction': 'DENY',
'UseGoogleCalendarAction': 'DENY',
'ZendeskAction': 'DENY',
'CreateAndUpdateZendeskAction': 'DENY',
'ShareZendeskAction': 'DENY',
'UseZendeskAction': 'DENY',
'SmartsheetAction': 'DENY',
'CreateAndUpdateSmartsheetAction': 'DENY',
'ShareSmartsheetAction': 'DENY',
'UseSmartsheetAction': 'DENY',
'SAPBusinessPartnerAction': 'DENY',
'CreateAndUpdateSAPBusinessPartnerAction': 'DENY',
'ShareSAPBusinessPartnerAction': 'DENY',
'UseSAPBusinessPartnerAction': 'DENY',
'SAPProductMasterDataAction': 'DENY',
'CreateAndUpdateSAPProductMasterDataAction': 'DENY',
'ShareSAPProductMasterDataAction': 'DENY',
'UseSAPProductMasterDataAction': 'DENY',
'SAPPhysicalInventoryAction': 'DENY',
'CreateAndUpdateSAPPhysicalInventoryAction': 'DENY',
'ShareSAPPhysicalInventoryAction': 'DENY',
'UseSAPPhysicalInventoryAction': 'DENY',
'SAPBillOfMaterialAction': 'DENY',
'CreateAndUpdateSAPBillOfMaterialAction': 'DENY',
'ShareSAPBillOfMaterialAction': 'DENY',
'UseSAPBillOfMaterialAction': 'DENY',
'SAPMaterialStockAction': 'DENY',
'CreateAndUpdateSAPMaterialStockAction': 'DENY',
'ShareSAPMaterialStockAction': 'DENY',
'UseSAPMaterialStockAction': 'DENY',
'FactSetAction': 'DENY',
'CreateAndUpdateFactSetAction': 'DENY',
'ShareFactSetAction': 'DENY',
'UseFactSetAction': 'DENY',
'AmazonSThreeAction': 'DENY',
'CreateAndUpdateAmazonSThreeAction': 'DENY',
'ShareAmazonSThreeAction': 'DENY',
'UseAmazonSThreeAction': 'DENY',
'TextractAction': 'DENY',
'CreateAndUpdateTextractAction': 'DENY',
'ShareTextractAction': 'DENY',
'UseTextractAction': 'DENY',
'ComprehendAction': 'DENY',
'CreateAndUpdateComprehendAction': 'DENY',
'ShareComprehendAction': 'DENY',
'UseComprehendAction': 'DENY',
'ComprehendMedicalAction': 'DENY',
'CreateAndUpdateComprehendMedicalAction': 'DENY',
'ShareComprehendMedicalAction': 'DENY',
'UseComprehendMedicalAction': 'DENY',
'AmazonBedrockARSAction': 'DENY',
'CreateAndUpdateAmazonBedrockARSAction': 'DENY',
'ShareAmazonBedrockARSAction': 'DENY',
'UseAmazonBedrockARSAction': 'DENY',
'AmazonBedrockFSAction': 'DENY',
'CreateAndUpdateAmazonBedrockFSAction': 'DENY',
'ShareAmazonBedrockFSAction': 'DENY',
'UseAmazonBedrockFSAction': 'DENY',
'AmazonBedrockKRSAction': 'DENY',
'CreateAndUpdateAmazonBedrockKRSAction': 'DENY',
'ShareAmazonBedrockKRSAction': 'DENY',
'UseAmazonBedrockKRSAction': 'DENY',
'MCPAction': 'DENY',
'CreateAndUpdateMCPAction': 'DENY',
'ShareMCPAction': 'DENY',
'UseMCPAction': 'DENY',
'OpenAPIAction': 'DENY',
'CreateAndUpdateOpenAPIAction': 'DENY',
'ShareOpenAPIAction': 'DENY',
'UseOpenAPIAction': 'DENY',
'SandPGMIAction': 'DENY',
'CreateAndUpdateSandPGMIAction': 'DENY',
'ShareSandPGMIAction': 'DENY',
'UseSandPGMIAction': 'DENY',
'SandPGlobalEnergyAction': 'DENY',
'CreateAndUpdateSandPGlobalEnergyAction': 'DENY',
'ShareSandPGlobalEnergyAction': 'DENY',
'UseSandPGlobalEnergyAction': 'DENY',
'BambooHRAction': 'DENY',
'CreateAndUpdateBambooHRAction': 'DENY',
'ShareBambooHRAction': 'DENY',
'UseBambooHRAction': 'DENY',
'BoxAgentAction': 'DENY',
'CreateAndUpdateBoxAgentAction': 'DENY',
'ShareBoxAgentAction': 'DENY',
'UseBoxAgentAction': 'DENY',
'CanvaAgentAction': 'DENY',
'CreateAndUpdateCanvaAgentAction': 'DENY',
'ShareCanvaAgentAction': 'DENY',
'UseCanvaAgentAction': 'DENY',
'GithubAction': 'DENY',
'CreateAndUpdateGithubAction': 'DENY',
'ShareGithubAction': 'DENY',
'UseGithubAction': 'DENY',
'NotionAction': 'DENY',
'CreateAndUpdateNotionAction': 'DENY',
'ShareNotionAction': 'DENY',
'UseNotionAction': 'DENY',
'LinearAction': 'DENY',
'CreateAndUpdateLinearAction': 'DENY',
'ShareLinearAction': 'DENY',
'UseLinearAction': 'DENY',
'HuggingFaceAction': 'DENY',
'CreateAndUpdateHuggingFaceAction': 'DENY',
'ShareHuggingFaceAction': 'DENY',
'UseHuggingFaceAction': 'DENY',
'MondayAction': 'DENY',
'CreateAndUpdateMondayAction': 'DENY',
'ShareMondayAction': 'DENY',
'UseMondayAction': 'DENY',
'HubspotAction': 'DENY',
'CreateAndUpdateHubspotAction': 'DENY',
'ShareHubspotAction': 'DENY',
'UseHubspotAction': 'DENY',
'IntercomAction': 'DENY',
'CreateAndUpdateIntercomAction': 'DENY',
'ShareIntercomAction': 'DENY',
'UseIntercomAction': 'DENY',
'NewRelicAction': 'DENY',
'CreateAndUpdateNewRelicAction': 'DENY',
'ShareNewRelicAction': 'DENY',
'UseNewRelicAction': 'DENY',
'Topic': 'DENY',
'EditVisualWithQ': 'DENY',
'BuildCalculatedFieldWithQ': 'DENY',
'CreateDashboardExecutiveSummaryWithQ': 'DENY',
'Space': 'DENY',
'CreateSpaces': 'DENY',
'ShareSpaces': 'DENY',
'ChatAgent': 'DENY',
'CreateChatAgents': 'DENY',
'ShareChatAgents': 'DENY',
'Research': 'DENY',
'SelfUpgradeUserRole': 'DENY',
'Extension': 'DENY',
'ManageSharedFolders': 'DENY',
'GenerateAnalyses': 'DENY'
}
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the custom permissions profile that you want to update.
string
[REQUIRED]
The name of the custom permissions profile that you want to update.
dict
A set of actions to include in the custom permissions profile.
ExportToCsv (string) --
The ability to export to CSV files from the UI.
ExportToExcel (string) --
The ability to export to Excel files from the UI.
ExportToPdf (string) --
The ability to export to PDF files from the UI.
PrintReports (string) --
The ability to print reports.
CreateAndUpdateThemes (string) --
The ability to export to Create and Update themes.
AddOrRunAnomalyDetectionForAnalyses (string) --
The ability to add or run anomaly detection.
ShareAnalyses (string) --
The ability to share analyses.
CreateAndUpdateDatasets (string) --
The ability to create and update datasets.
ShareDatasets (string) --
The ability to share datasets.
SubscribeDashboardEmailReports (string) --
The ability to subscribe to email reports.
CreateAndUpdateDashboardEmailReports (string) --
The ability to create and update email reports.
ShareDashboards (string) --
The ability to share dashboards.
CreateAndUpdateThresholdAlerts (string) --
The ability to create and update threshold alerts.
RenameSharedFolders (string) --
The ability to rename shared folders.
CreateSharedFolders (string) --
The ability to create shared folders.
CreateAndUpdateDataSources (string) --
The ability to create and update data sources.
ShareDataSources (string) --
The ability to share data sources.
ViewAccountSPICECapacity (string) --
The ability to view account SPICE capacity.
CreateSPICEDataset (string) --
The ability to create a SPICE dataset.
ExportToPdfInScheduledReports (string) --
The ability to export to PDF files in scheduled email reports.
ExportToCsvInScheduledReports (string) --
The ability to export to CSV files in scheduled email reports.
ExportToExcelInScheduledReports (string) --
The ability to export to Excel files in scheduled email reports.
IncludeContentInScheduledReportsEmail (string) --
The ability to include content in scheduled email reports.
Dashboard (string) --
The ability to perform dashboard-related actions.
Analysis (string) --
The ability to perform analysis-related actions.
Automate (string) --
The ability to perform automate-related actions.
Flow (string) --
The ability to perform flow-related actions.
PublishWithoutApproval (string) --
The ability to enable approvals for flow share.
UseBedrockModels (string) --
The ability to use Bedrock models for general knowledge step in flows.
PerformFlowUiTask (string) --
The ability to use UI Agent step to perform tasks on public websites.
ApproveFlowShareRequests (string) --
The ability to review and approve sharing requests of Flows.
UseAgentWebSearch (string) --
The ability to use internet to enhance results in Chat Agents, Flows, and Quick Research. Web search queries will be processed securely in an Amazon Web Services region us-east-1.
KnowledgeBase (string) --
The ability to use knowledge bases to specify content from external applications.
Action (string) --
The ability to perform actions in external services through Action connectors. Actions allow users to interact with third-party systems.
GenericHTTPAction (string) --
The ability to perform actions using REST API connection connectors.
CreateAndUpdateGenericHTTPAction (string) --
The ability to create and update REST API connection actions.
ShareGenericHTTPAction (string) --
The ability to share REST API connection actions.
UseGenericHTTPAction (string) --
The ability to use REST API connection actions.
AsanaAction (string) --
The ability to perform actions using Asana connectors.
CreateAndUpdateAsanaAction (string) --
The ability to create and update Asana actions.
ShareAsanaAction (string) --
The ability to share Asana actions.
UseAsanaAction (string) --
The ability to use Asana actions.
SlackAction (string) --
The ability to perform actions using Slack connectors.
CreateAndUpdateSlackAction (string) --
The ability to create and update Slack actions.
ShareSlackAction (string) --
The ability to share Slack actions.
UseSlackAction (string) --
The ability to use Slack actions.
ServiceNowAction (string) --
The ability to perform actions using ServiceNow connectors.
CreateAndUpdateServiceNowAction (string) --
The ability to create and update ServiceNow actions.
ShareServiceNowAction (string) --
The ability to share ServiceNow actions.
UseServiceNowAction (string) --
The ability to use ServiceNow actions.
SalesforceAction (string) --
The ability to perform actions using Salesforce connectors.
CreateAndUpdateSalesforceAction (string) --
The ability to create and update Salesforce actions.
ShareSalesforceAction (string) --
The ability to share Salesforce actions.
UseSalesforceAction (string) --
The ability to use Salesforce actions.
MSExchangeAction (string) --
The ability to perform actions using Microsoft Outlook connectors.
CreateAndUpdateMSExchangeAction (string) --
The ability to create and update Microsoft Outlook actions.
ShareMSExchangeAction (string) --
The ability to share Microsoft Outlook actions.
UseMSExchangeAction (string) --
The ability to use Microsoft Outlook actions.
PagerDutyAction (string) --
The ability to perform actions using PagerDuty Advance connectors.
CreateAndUpdatePagerDutyAction (string) --
The ability to create and update PagerDuty Advance actions.
SharePagerDutyAction (string) --
The ability to share PagerDuty Advance actions.
UsePagerDutyAction (string) --
The ability to use PagerDuty Advance actions.
JiraAction (string) --
The ability to perform actions using Jira connectors.
CreateAndUpdateJiraAction (string) --
The ability to create and update Jira actions.
ShareJiraAction (string) --
The ability to share Jira actions.
UseJiraAction (string) --
The ability to use Jira actions.
ConfluenceAction (string) --
The ability to perform actions using Atlassian Confluence Cloud connectors.
CreateAndUpdateConfluenceAction (string) --
The ability to create and update Atlassian Confluence Cloud actions.
ShareConfluenceAction (string) --
The ability to share Atlassian Confluence Cloud actions.
UseConfluenceAction (string) --
The ability to use Atlassian Confluence Cloud actions.
OneDriveAction (string) --
The ability to perform actions using Microsoft OneDrive connectors.
CreateAndUpdateOneDriveAction (string) --
The ability to create and update Microsoft OneDrive actions.
ShareOneDriveAction (string) --
The ability to share Microsoft OneDrive actions.
UseOneDriveAction (string) --
The ability to use Microsoft OneDrive actions.
SharePointAction (string) --
The ability to perform actions using Microsoft SharePoint Online connectors.
CreateAndUpdateSharePointAction (string) --
The ability to create and update Microsoft SharePoint Online actions.
ShareSharePointAction (string) --
The ability to share Microsoft SharePoint Online actions.
UseSharePointAction (string) --
The ability to use Microsoft SharePoint Online actions.
MSTeamsAction (string) --
The ability to perform actions using Microsoft Teams connectors.
CreateAndUpdateMSTeamsAction (string) --
The ability to create and update Microsoft Teams actions.
ShareMSTeamsAction (string) --
The ability to share Microsoft Teams actions.
UseMSTeamsAction (string) --
The ability to use Microsoft Teams actions.
GoogleCalendarAction (string) --
The ability to perform actions using Google Calendar connectors.
CreateAndUpdateGoogleCalendarAction (string) --
The ability to create and update Google Calendar actions.
ShareGoogleCalendarAction (string) --
The ability to share Google Calendar actions.
UseGoogleCalendarAction (string) --
The ability to use Google Calendar actions.
ZendeskAction (string) --
The ability to perform actions using Zendesk connectors.
CreateAndUpdateZendeskAction (string) --
The ability to create and update Zendesk actions.
ShareZendeskAction (string) --
The ability to share Zendesk actions.
UseZendeskAction (string) --
The ability to use Zendesk actions.
SmartsheetAction (string) --
The ability to perform actions using Smartsheet connectors.
CreateAndUpdateSmartsheetAction (string) --
The ability to create and update Smartsheet actions.
ShareSmartsheetAction (string) --
The ability to share Smartsheet actions.
UseSmartsheetAction (string) --
The ability to use Smartsheet actions.
SAPBusinessPartnerAction (string) --
The ability to perform actions using SAP Business Partner connectors.
CreateAndUpdateSAPBusinessPartnerAction (string) --
The ability to create and update SAP Business Partner actions.
ShareSAPBusinessPartnerAction (string) --
The ability to share SAP Business Partner actions.
UseSAPBusinessPartnerAction (string) --
The ability to use SAP Business Partner actions.
SAPProductMasterDataAction (string) --
The ability to perform actions using SAP Product Master connectors.
CreateAndUpdateSAPProductMasterDataAction (string) --
The ability to create and update SAP Product Master actions.
ShareSAPProductMasterDataAction (string) --
The ability to share SAP Product Master actions.
UseSAPProductMasterDataAction (string) --
The ability to use SAP Product Master actions.
SAPPhysicalInventoryAction (string) --
The ability to perform actions using SAP Physical Inventory connectors.
CreateAndUpdateSAPPhysicalInventoryAction (string) --
The ability to create and update SAP Physical Inventory actions.
ShareSAPPhysicalInventoryAction (string) --
The ability to share SAP Physical Inventory actions.
UseSAPPhysicalInventoryAction (string) --
The ability to use SAP Physical Inventory actions.
SAPBillOfMaterialAction (string) --
The ability to perform actions using SAP Bill of Materials connectors.
CreateAndUpdateSAPBillOfMaterialAction (string) --
The ability to create and update SAP Bill of Materials actions.
ShareSAPBillOfMaterialAction (string) --
The ability to share SAP Bill of Materials actions.
UseSAPBillOfMaterialAction (string) --
The ability to use SAP Bill of Materials actions.
SAPMaterialStockAction (string) --
The ability to perform actions using SAP Material Stock connectors.
CreateAndUpdateSAPMaterialStockAction (string) --
The ability to create and update SAP Material Stock actions.
ShareSAPMaterialStockAction (string) --
The ability to share SAP Material Stock actions.
UseSAPMaterialStockAction (string) --
The ability to use SAP Material Stock actions.
FactSetAction (string) --
The ability to perform actions using FactSet connectors.
CreateAndUpdateFactSetAction (string) --
The ability to create and update FactSet actions.
ShareFactSetAction (string) --
The ability to share FactSet actions.
UseFactSetAction (string) --
The ability to use FactSet actions.
AmazonSThreeAction (string) --
The ability to perform actions using Amazon S3 connectors.
CreateAndUpdateAmazonSThreeAction (string) --
The ability to create and update Amazon S3 actions.
ShareAmazonSThreeAction (string) --
The ability to share Amazon S3 actions.
UseAmazonSThreeAction (string) --
The ability to use Amazon S3 actions.
TextractAction (string) --
The ability to perform actions using Textract connectors.
CreateAndUpdateTextractAction (string) --
The ability to create and update Textract actions.
ShareTextractAction (string) --
The ability to share Textract actions.
UseTextractAction (string) --
The ability to use Textract actions.
ComprehendAction (string) --
The ability to perform actions using Comprehend connectors.
CreateAndUpdateComprehendAction (string) --
The ability to create and update Comprehend actions.
ShareComprehendAction (string) --
The ability to share Comprehend actions.
UseComprehendAction (string) --
The ability to use Comprehend actions.
ComprehendMedicalAction (string) --
The ability to perform actions using Comprehend Medical connectors.
CreateAndUpdateComprehendMedicalAction (string) --
The ability to create and update Comprehend Medical actions.
ShareComprehendMedicalAction (string) --
The ability to share Comprehend Medical actions.
UseComprehendMedicalAction (string) --
The ability to use Comprehend Medical actions.
AmazonBedrockARSAction (string) --
The ability to perform actions using Bedrock Agent connectors.
CreateAndUpdateAmazonBedrockARSAction (string) --
The ability to create and update Bedrock Agent actions.
ShareAmazonBedrockARSAction (string) --
The ability to share Bedrock Agent actions.
UseAmazonBedrockARSAction (string) --
The ability to use Bedrock Agent actions.
AmazonBedrockFSAction (string) --
The ability to perform actions using Bedrock Runtime connectors.
CreateAndUpdateAmazonBedrockFSAction (string) --
The ability to create and update Bedrock Runtime actions.
ShareAmazonBedrockFSAction (string) --
The ability to share Bedrock Runtime actions.
UseAmazonBedrockFSAction (string) --
The ability to use Bedrock Runtime actions.
AmazonBedrockKRSAction (string) --
The ability to perform actions using Bedrock Data Automation Runtime connectors.
CreateAndUpdateAmazonBedrockKRSAction (string) --
The ability to create and update Bedrock Data Automation Runtime actions.
ShareAmazonBedrockKRSAction (string) --
The ability to share Bedrock Data Automation Runtime actions.
UseAmazonBedrockKRSAction (string) --
The ability to use Bedrock Data Automation Runtime actions.
MCPAction (string) --
The ability to perform actions using Model Context Protocol connectors.
CreateAndUpdateMCPAction (string) --
The ability to create and update Model Context Protocol actions.
ShareMCPAction (string) --
The ability to share Model Context Protocol actions.
UseMCPAction (string) --
The ability to use Model Context Protocol actions.
OpenAPIAction (string) --
The ability to perform actions using OpenAPI Specification connectors.
CreateAndUpdateOpenAPIAction (string) --
The ability to create and update OpenAPI Specification actions.
ShareOpenAPIAction (string) --
The ability to share OpenAPI Specification actions.
UseOpenAPIAction (string) --
The ability to use OpenAPI Specification actions.
SandPGMIAction (string) --
The ability to perform actions using S&P Global Market Intelligence connectors.
CreateAndUpdateSandPGMIAction (string) --
The ability to create and update S&P Global Market Intelligence actions.
ShareSandPGMIAction (string) --
The ability to share S&P Global Market Intelligence actions.
UseSandPGMIAction (string) --
The ability to use S&P Global Market Intelligence actions.
SandPGlobalEnergyAction (string) --
The ability to perform actions using S&P Global Energy connectors.
CreateAndUpdateSandPGlobalEnergyAction (string) --
The ability to create and update S&P Global Energy actions.
ShareSandPGlobalEnergyAction (string) --
The ability to share S&P Global Energy actions.
UseSandPGlobalEnergyAction (string) --
The ability to use S&P Global Energy actions.
BambooHRAction (string) --
The ability to perform actions using BambooHR connectors.
CreateAndUpdateBambooHRAction (string) --
The ability to create and update BambooHR actions.
ShareBambooHRAction (string) --
The ability to share BambooHR actions.
UseBambooHRAction (string) --
The ability to use BambooHR actions.
BoxAgentAction (string) --
The ability to perform actions using Box Agent connectors.
CreateAndUpdateBoxAgentAction (string) --
The ability to create and update Box Agent actions.
ShareBoxAgentAction (string) --
The ability to share Box Agent actions.
UseBoxAgentAction (string) --
The ability to use Box Agent actions.
CanvaAgentAction (string) --
The ability to perform actions using Canva Agent connectors.
CreateAndUpdateCanvaAgentAction (string) --
The ability to create and update Canva Agent actions.
ShareCanvaAgentAction (string) --
The ability to share Canva Agent actions.
UseCanvaAgentAction (string) --
The ability to use Canva Agent actions.
GithubAction (string) --
The ability to perform actions using GitHub connectors.
CreateAndUpdateGithubAction (string) --
The ability to create and update GitHub actions.
ShareGithubAction (string) --
The ability to share GitHub actions.
UseGithubAction (string) --
The ability to use GitHub actions.
NotionAction (string) --
The ability to perform actions using Notion connectors.
CreateAndUpdateNotionAction (string) --
The ability to create and update Notion actions.
ShareNotionAction (string) --
The ability to share Notion actions.
UseNotionAction (string) --
The ability to use Notion actions.
LinearAction (string) --
The ability to perform actions using Linear connectors.
CreateAndUpdateLinearAction (string) --
The ability to create and update Linear actions.
ShareLinearAction (string) --
The ability to share Linear actions.
UseLinearAction (string) --
The ability to use Linear actions.
HuggingFaceAction (string) --
The ability to perform actions using HuggingFace connectors.
CreateAndUpdateHuggingFaceAction (string) --
The ability to create and update HuggingFace actions.
ShareHuggingFaceAction (string) --
The ability to share HuggingFace actions.
UseHuggingFaceAction (string) --
The ability to use HuggingFace actions.
MondayAction (string) --
The ability to perform actions using Monday connectors.
CreateAndUpdateMondayAction (string) --
The ability to create and update Monday actions.
ShareMondayAction (string) --
The ability to share Monday actions.
UseMondayAction (string) --
The ability to use Monday actions.
HubspotAction (string) --
The ability to perform actions using Hubspot connectors.
CreateAndUpdateHubspotAction (string) --
The ability to create and update Hubspot actions.
ShareHubspotAction (string) --
The ability to share Hubspot actions.
UseHubspotAction (string) --
The ability to use Hubspot actions.
IntercomAction (string) --
The ability to perform actions using Intercom connectors.
CreateAndUpdateIntercomAction (string) --
The ability to create and update Intercom actions.
ShareIntercomAction (string) --
The ability to share Intercom actions.
UseIntercomAction (string) --
The ability to use Intercom actions.
NewRelicAction (string) --
The ability to perform actions using New Relic connectors.
CreateAndUpdateNewRelicAction (string) --
The ability to create and update New Relic actions.
ShareNewRelicAction (string) --
The ability to share New Relic actions.
UseNewRelicAction (string) --
The ability to use New Relic actions.
Topic (string) --
The ability to perform Topic-related actions.
EditVisualWithQ (string) --
The ability to Edit Visual with AI
BuildCalculatedFieldWithQ (string) --
The ability to Build Calculation with AI
CreateDashboardExecutiveSummaryWithQ (string) --
The ability to Create Executive Summary
Space (string) --
The ability to perform space-related actions.
CreateSpaces (string) --
The ability to create spaces.
ShareSpaces (string) --
The ability to share spaces with other users and groups.
ChatAgent (string) --
The ability to perform chat-related actions.
CreateChatAgents (string) --
The ability to create chat agents.
ShareChatAgents (string) --
The ability to share chat agents with other users and groups.
Research (string) --
The ability to perform research-related actions.
SelfUpgradeUserRole (string) --
The ability to enable users to upgrade their user role.
Extension (string) --
The ability to perform Extension-related actions.
ManageSharedFolders (string) --
The ability to create, update, delete and view shared folders (both restricted and unrestricted), ability to add any asset to shared folders, and ability to share the folders.
Note: This does not prevent inheriting access to assets that others share with them through folder membership.
GenerateAnalyses (string) --
The ability to generate analysis using AI
dict
Response Syntax
{
'Status': 123,
'Arn': 'string',
'RequestId': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
Arn (string) --
The Amazon Resource Name (ARN) of the custom permissions profile.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'FilterGroups': {'Filters': {'CategoryFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'NestedFilter': {'InnerFilter': {'CategoryInnerFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}}}},
'NumericEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'NumericRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'RelativeDatesFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'TimeEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'TimeRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'TopBottomFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}}}},
'Sheets': {'FilterControls': {'Dropdown': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'List': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}},
'ParameterControls': {'Dropdown': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'List': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}}}
Updates a dashboard in an 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 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': {'AthenaParameters': {'ConsumerAccountRoleArn': 'string'},
'S3TablesParameters': {'TableBucketArn': 'string'}}}},
'DataSourceParameters': {'AthenaParameters': {'ConsumerAccountRoleArn': 'string'},
'S3TablesParameters': {'TableBucketArn': 'string'}}}
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',
'ConsumerAccountRoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'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',
'UseServiceName': True|False
},
'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
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': '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',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
}
},
Credentials={
'CredentialPair': {
'Username': 'string',
'Password': 'string',
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string',
'ConsumerAccountRoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'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',
'UseServiceName': True|False
},
'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
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': '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',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
}
},
]
},
'CopySourceArn': 'string',
'SecretArn': 'string',
'KeyPairCredentials': {
'KeyPairUsername': 'string',
'PrivateKey': 'string',
'PrivateKeyPassphrase': 'string'
},
'WebProxyCredentials': {
'WebProxyUsername': 'string',
'WebProxyPassword': 'string'
},
'OAuthClientCredentials': {
'ClientId': 'string',
'ClientSecret': 'string',
'Username': '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 Quick Sight 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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
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 Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight 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 Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight 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, Quick Sight 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.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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 Quick Sight.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base 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 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) -- [REQUIRED]
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
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.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
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.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
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.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) -- [REQUIRED]
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) -- [REQUIRED]
The host name of the Impala data source.
Port (integer) -- [REQUIRED]
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) -- [REQUIRED]
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) -- [REQUIRED]
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Q Business application.
dict
The credentials that Amazon Quick Sight 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 Quick Sight 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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
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 Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight 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 Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight 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, Quick Sight 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.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
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 Quick Sight.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base 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 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) -- [REQUIRED]
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
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.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
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.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
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.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) -- [REQUIRED]
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) -- [REQUIRED]
The host name of the Impala data source.
Port (integer) -- [REQUIRED]
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) -- [REQUIRED]
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) -- [REQUIRED]
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Q Business application.
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.
KeyPairCredentials (dict) --
The credentials for connecting using key-pair.
KeyPairUsername (string) -- [REQUIRED]
Username
PrivateKey (string) -- [REQUIRED]
PrivateKey
PrivateKeyPassphrase (string) --
PrivateKeyPassphrase
WebProxyCredentials (dict) --
The credentials for connecting through a web proxy server.
WebProxyUsername (string) -- [REQUIRED]
The username for authenticating with the web proxy server.
WebProxyPassword (string) -- [REQUIRED]
The password for authenticating with the web proxy server.
OAuthClientCredentials (dict) --
The OAuth client credentials for connecting to a data source using OAuth 2.0 client credentials (2LO) authentication. For more information, see ``OAuthClientCredentials ``.
ClientId (string) --
The client ID of the OAuth 2.0 application that is registered with the data source provider.
ClientSecret (string) --
The client secret of the OAuth 2.0 application that is registered with the data source provider.
Username (string) --
The username of the account that is used for OAuth 2.0 client credentials authentication with the data source provider.
dict
Use this parameter only when you want Amazon Quick Sight 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 Quick Sight 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': {'CategoryFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'NestedFilter': {'InnerFilter': {'CategoryInnerFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}}}},
'NumericEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'NumericRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'RelativeDatesFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'TimeEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'TimeRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}},
'TopBottomFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDropdownOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'DefaultListOptions': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}}}},
'Sheets': {'FilterControls': {'Dropdown': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'List': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}},
'ParameterControls': {'Dropdown': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]},
'List': {'ControlSortConfigurations': [{'ControlColumnSort': {'AggregationFunction': {'AttributeAggregationFunction': {'SimpleAttributeAggregation': 'UNIQUE_VALUE',
'ValueForMultipleValues': 'string'},
'CategoricalAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT',
'DateAggregationFunction': 'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'MIN '
'| '
'MAX',
'NumericalAggregationFunction': {'PercentileAggregation': {'PercentileValue': 'double'},
'SimpleNumericalAggregation': 'SUM '
'| '
'AVERAGE '
'| '
'MIN '
'| '
'MAX '
'| '
'COUNT '
'| '
'DISTINCT_COUNT '
'| '
'VAR '
'| '
'VARP '
'| '
'STDEV '
'| '
'STDEVP '
'| '
'MEDIAN'}},
'Column': {'ColumnName': 'string',
'DataSetIdentifier': 'string'},
'SortDirection': 'ASC '
'| '
'DESC'},
'SelectableValuesSort': {'Direction': 'ASC '
'| '
'DESC '
'| '
'USER_DEFINED_ORDER'}}]}}}}}
Updates a template from an existing Amazon Quick Sight 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.