Describe Data Set
| quicksight_describe_data_set | R Documentation |
Describes a dataset¶
Description¶
Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.
Usage¶
quicksight_describe_data_set(AwsAccountId, DataSetId)
Arguments¶
AwsAccountId |
[required] The Amazon Web Services account ID. |
DataSetId |
[required] The ID for the dataset that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. |
Value¶
A list with the following syntax:
list(
DataSet = list(
Arn = "string",
DataSetId = "string",
Name = "string",
CreatedTime = as.POSIXct(
"2015-01-01"
),
LastUpdatedTime = as.POSIXct(
"2015-01-01"
),
PhysicalTableMap = list(
list(
RelationalTable = list(
DataSourceArn = "string",
Catalog = "string",
Schema = "string",
Name = "string",
InputColumns = list(
list(
Name = "string",
Id = "string",
Type = "STRING"|"INTEGER"|"DECIMAL"|"DATETIME"|"BIT"|"BOOLEAN"|"JSON"|"SEMISTRUCT",
SubType = "FLOAT"|"FIXED"
)
)
),
CustomSql = list(
DataSourceArn = "string",
Name = "string",
SqlQuery = "string",
Columns = list(
list(
Name = "string",
Id = "string",
Type = "STRING"|"INTEGER"|"DECIMAL"|"DATETIME"|"BIT"|"BOOLEAN"|"JSON"|"SEMISTRUCT",
SubType = "FLOAT"|"FIXED"
)
)
),
S3Source = list(
DataSourceArn = "string",
UploadSettings = list(
Format = "CSV"|"TSV"|"CLF"|"ELF"|"XLSX"|"JSON",
StartFromRow = 123,
ContainsHeader = TRUE|FALSE,
TextQualifier = "DOUBLE_QUOTE"|"SINGLE_QUOTE",
Delimiter = "string",
CustomCellAddressRange = "string"
),
InputColumns = list(
list(
Name = "string",
Id = "string",
Type = "STRING"|"INTEGER"|"DECIMAL"|"DATETIME"|"BIT"|"BOOLEAN"|"JSON"|"SEMISTRUCT",
SubType = "FLOAT"|"FIXED"
)
)
),
SaaSTable = list(
DataSourceArn = "string",
TablePath = list(
list(
Name = "string",
Id = "string"
)
),
InputColumns = list(
list(
Name = "string",
Id = "string",
Type = "STRING"|"INTEGER"|"DECIMAL"|"DATETIME"|"BIT"|"BOOLEAN"|"JSON"|"SEMISTRUCT",
SubType = "FLOAT"|"FIXED"
)
)
)
)
),
LogicalTableMap = list(
list(
Alias = "string",
DataTransforms = list(
list(
ProjectOperation = list(
Alias = "string",
Source = list(
TransformOperationId = "string",
ColumnIdMappings = list(
list(
SourceColumnId = "string",
TargetColumnId = "string"
)
)
),
ProjectedColumns = list(
"string"
)
),
FilterOperation = list(
ConditionExpression = "string",
StringFilterCondition = list(
ColumnName = "string",
ComparisonFilterCondition = list(
Operator = "EQUALS"|"DOES_NOT_EQUAL"|"CONTAINS"|"DOES_NOT_CONTAIN"|"STARTS_WITH"|"ENDS_WITH",
Value = list(
StaticValue = "string"
)
),
ListFilterCondition = list(
Operator = "INCLUDE"|"EXCLUDE",
Values = list(
StaticValues = list(
"string"
)
)
)
),
NumericFilterCondition = list(
ColumnName = "string",
ComparisonFilterCondition = list(
Operator = "EQUALS"|"DOES_NOT_EQUAL"|"GREATER_THAN"|"GREATER_THAN_OR_EQUALS_TO"|"LESS_THAN"|"LESS_THAN_OR_EQUALS_TO",
Value = list(
StaticValue = 123.0
)
),
RangeFilterCondition = list(
RangeMinimum = list(
StaticValue = 123.0
),
RangeMaximum = list(
StaticValue = 123.0
),
IncludeMinimum = TRUE|FALSE,
IncludeMaximum = TRUE|FALSE
)
),
DateFilterCondition = list(
ColumnName = "string",
ComparisonFilterCondition = list(
Operator = "BEFORE"|"BEFORE_OR_EQUALS_TO"|"AFTER"|"AFTER_OR_EQUALS_TO",
Value = list(
StaticValue = as.POSIXct(
"2015-01-01"
)
)
),
RangeFilterCondition = list(
RangeMinimum = list(
StaticValue = as.POSIXct(
"2015-01-01"
)
),
RangeMaximum = list(
StaticValue = as.POSIXct(
"2015-01-01"
)
),
IncludeMinimum = TRUE|FALSE,
IncludeMaximum = TRUE|FALSE
)
)
),
CreateColumnsOperation = list(
Alias = "string",
Source = list(
TransformOperationId = "string",
ColumnIdMappings = list(
list(
SourceColumnId = "string",
TargetColumnId = "string"
)
)
),
Columns = list(
list(
ColumnName = "string",
ColumnId = "string",
Expression = "string"
)
)
),
RenameColumnOperation = list(
ColumnName = "string",
NewColumnName = "string"
),
CastColumnTypeOperation = list(
ColumnName = "string",
NewColumnType = "STRING"|"INTEGER"|"DECIMAL"|"DATETIME",
SubType = "FLOAT"|"FIXED",
Format = "string"
),
TagColumnOperation = list(
ColumnName = "string",
Tags = list(
list(
ColumnGeographicRole = "COUNTRY"|"STATE"|"COUNTY"|"CITY"|"POSTCODE"|"LONGITUDE"|"LATITUDE",
ColumnDescription = list(
Text = "string"
)
)
)
),
UntagColumnOperation = list(
ColumnName = "string",
TagNames = list(
"COLUMN_GEOGRAPHIC_ROLE"|"COLUMN_DESCRIPTION"
)
),
OverrideDatasetParameterOperation = list(
ParameterName = "string",
NewParameterName = "string",
NewDefaultValues = list(
StringStaticValues = list(
"string"
),
DecimalStaticValues = list(
123.0
),
DateTimeStaticValues = list(
as.POSIXct(
"2015-01-01"
)
),
IntegerStaticValues = list(
123
)
)
)
)
),
Source = list(
JoinInstruction = list(
LeftOperand = "string",
RightOperand = "string",
LeftJoinKeyProperties = list(
UniqueKey = TRUE|FALSE
),
RightJoinKeyProperties = list(
UniqueKey = TRUE|FALSE
),
Type = "INNER"|"OUTER"|"LEFT"|"RIGHT",
OnClause = "string"
),
PhysicalTableId = "string",
DataSetArn = "string"
)
)
),
OutputColumns = list(
list(
Name = "string",
Id = "string",
Description = "string",
Type = "STRING"|"INTEGER"|"DECIMAL"|"DATETIME",
SubType = "FLOAT"|"FIXED"
)
),
ImportMode = "SPICE"|"DIRECT_QUERY",
ConsumedSpiceCapacityInBytes = 123,
ColumnGroups = list(
list(
GeoSpatialColumnGroup = list(
Name = "string",
CountryCode = "US",
Columns = list(
"string"
)
)
)
),
FieldFolders = list(
list(
description = "string",
columns = list(
"string"
)
)
),
RowLevelPermissionDataSet = list(
Namespace = "string",
Arn = "string",
PermissionPolicy = "GRANT_ACCESS"|"DENY_ACCESS",
FormatVersion = "VERSION_1"|"VERSION_2",
Status = "ENABLED"|"DISABLED"
),
RowLevelPermissionTagConfiguration = list(
Status = "ENABLED"|"DISABLED",
TagRules = list(
list(
TagKey = "string",
ColumnName = "string",
TagMultiValueDelimiter = "string",
MatchAllValue = "string"
)
),
TagRuleConfigurations = list(
list(
"string"
)
)
),
ColumnLevelPermissionRules = list(
list(
Principals = list(
"string"
),
ColumnNames = list(
"string"
)
)
),
DataSetUsageConfiguration = list(
DisableUseAsDirectQuerySource = TRUE|FALSE,
DisableUseAsImportedSource = TRUE|FALSE
),
DatasetParameters = list(
list(
StringDatasetParameter = list(
Id = "string",
Name = "string",
ValueType = "MULTI_VALUED"|"SINGLE_VALUED",
DefaultValues = list(
StaticValues = list(
"string"
)
)
),
DecimalDatasetParameter = list(
Id = "string",
Name = "string",
ValueType = "MULTI_VALUED"|"SINGLE_VALUED",
DefaultValues = list(
StaticValues = list(
123.0
)
)
),
IntegerDatasetParameter = list(
Id = "string",
Name = "string",
ValueType = "MULTI_VALUED"|"SINGLE_VALUED",
DefaultValues = list(
StaticValues = list(
123
)
)
),
DateTimeDatasetParameter = list(
Id = "string",
Name = "string",
ValueType = "MULTI_VALUED"|"SINGLE_VALUED",
TimeGranularity = "YEAR"|"QUARTER"|"MONTH"|"WEEK"|"DAY"|"HOUR"|"MINUTE"|"SECOND"|"MILLISECOND",
DefaultValues = list(
StaticValues = list(
as.POSIXct(
"2015-01-01"
)
)
)
)
)
),
PerformanceConfiguration = list(
UniqueKeys = list(
list(
ColumnNames = list(
"string"
)
)
)
),
UseAs = "RLS_RULES",
DataPrepConfiguration = list(
SourceTableMap = list(
list(
PhysicalTableId = "string",
DataSet = list(
DataSetArn = "string",
InputColumns = list(
list(
Name = "string",
Id = "string",
Type = "STRING"|"INTEGER"|"DECIMAL"|"DATETIME"|"BIT"|"BOOLEAN"|"JSON"|"SEMISTRUCT",
SubType = "FLOAT"|"FIXED"
)
)
)
)
),
TransformStepMap = list(
list(
ImportTableStep = list(
Alias = "string",
Source = list(
SourceTableId = "string",
ColumnIdMappings = list(
list(
SourceColumnId = "string",
TargetColumnId = "string"
)
)
)
),
ProjectStep = list(
Alias = "string",
Source = list(
TransformOperationId = "string",
ColumnIdMappings = list(
list(
SourceColumnId = "string",
TargetColumnId = "string"
)
)
),
ProjectedColumns = list(
"string"
)
),
FiltersStep = list(
Alias = "string",
Source = list(
TransformOperationId = "string",
ColumnIdMappings = list(
list(
SourceColumnId = "string",
TargetColumnId = "string"
)
)
),
FilterOperations = list(
list(
ConditionExpression = "string",
StringFilterCondition = list(
ColumnName = "string",
ComparisonFilterCondition = list(
Operator = "EQUALS"|"DOES_NOT_EQUAL"|"CONTAINS"|"DOES_NOT_CONTAIN"|"STARTS_WITH"|"ENDS_WITH",
Value = list(
StaticValue = "string"
)
),
ListFilterCondition = list(
Operator = "INCLUDE"|"EXCLUDE",
Values = list(
StaticValues = list(
"string"
)
)
)
),
NumericFilterCondition = list(
ColumnName = "string",
ComparisonFilterCondition = list(
Operator = "EQUALS"|"DOES_NOT_EQUAL"|"GREATER_THAN"|"GREATER_THAN_OR_EQUALS_TO"|"LESS_THAN"|"LESS_THAN_OR_EQUALS_TO",
Value = list(
StaticValue = 123.0
)
),
RangeFilterCondition = list(
RangeMinimum = list(
StaticValue = 123.0
),
RangeMaximum = list(
StaticValue = 123.0
),
IncludeMinimum = TRUE|FALSE,
IncludeMaximum = TRUE|FALSE
)
),
DateFilterCondition = list(
ColumnName = "string",
ComparisonFilterCondition = list(
Operator = "BEFORE"|"BEFORE_OR_EQUALS_TO"|"AFTER"|"AFTER_OR_EQUALS_TO",
Value = list(
StaticValue = as.POSIXct(
"2015-01-01"
)
)
),
RangeFilterCondition = list(
RangeMinimum = list(
StaticValue = as.POSIXct(
"2015-01-01"
)
),
RangeMaximum = list(
StaticValue = as.POSIXct(
"2015-01-01"
)
),
IncludeMinimum = TRUE|FALSE,
IncludeMaximum = TRUE|FALSE
)
)
)
)
),
CreateColumnsStep = list(
Alias = "string",
Source = list(
TransformOperationId = "string",
ColumnIdMappings = list(
list(
SourceColumnId = "string",
TargetColumnId = "string"
)
)
),
Columns = list(
list(
ColumnName = "string",
ColumnId = "string",
Expression = "string"
)
)
),
RenameColumnsStep = list(
Alias = "string",
Source = list(
TransformOperationId = "string",
ColumnIdMappings = list(
list(
SourceColumnId = "string",
TargetColumnId = "string"
)
)
),
RenameColumnOperations = list(
list(
ColumnName = "string",
NewColumnName = "string"
)
)
),
CastColumnTypesStep = list(
Alias = "string",
Source = list(
TransformOperationId = "string",
ColumnIdMappings = list(
list(
SourceColumnId = "string",
TargetColumnId = "string"
)
)
),
CastColumnTypeOperations = list(
list(
ColumnName = "string",
NewColumnType = "STRING"|"INTEGER"|"DECIMAL"|"DATETIME",
SubType = "FLOAT"|"FIXED",
Format = "string"
)
)
),
JoinStep = list(
Alias = "string",
LeftOperand = list(
TransformOperationId = "string",
ColumnIdMappings = list(
list(
SourceColumnId = "string",
TargetColumnId = "string"
)
)
),
RightOperand = list(
TransformOperationId = "string",
ColumnIdMappings = list(
list(
SourceColumnId = "string",
TargetColumnId = "string"
)
)
),
Type = "INNER"|"OUTER"|"LEFT"|"RIGHT",
OnClause = "string",
LeftOperandProperties = list(
OutputColumnNameOverrides = list(
list(
SourceColumnName = "string",
OutputColumnName = "string"
)
)
),
RightOperandProperties = list(
OutputColumnNameOverrides = list(
list(
SourceColumnName = "string",
OutputColumnName = "string"
)
)
)
),
AggregateStep = list(
Alias = "string",
Source = list(
TransformOperationId = "string",
ColumnIdMappings = list(
list(
SourceColumnId = "string",
TargetColumnId = "string"
)
)
),
GroupByColumnNames = list(
"string"
),
Aggregations = list(
list(
AggregationFunction = list(
SimpleAggregation = list(
InputColumnName = "string",
FunctionType = "COUNT"|"DISTINCT_COUNT"|"SUM"|"AVERAGE"|"MAX"|"MIN"
),
ListAggregation = list(
InputColumnName = "string",
Separator = "string",
Distinct = TRUE|FALSE
)
),
NewColumnName = "string",
NewColumnId = "string"
)
)
),
PivotStep = list(
Alias = "string",
Source = list(
TransformOperationId = "string",
ColumnIdMappings = list(
list(
SourceColumnId = "string",
TargetColumnId = "string"
)
)
),
GroupByColumnNames = list(
"string"
),
ValueColumnConfiguration = list(
AggregationFunction = list(
SimpleAggregation = list(
InputColumnName = "string",
FunctionType = "COUNT"|"DISTINCT_COUNT"|"SUM"|"AVERAGE"|"MAX"|"MIN"
),
ListAggregation = list(
InputColumnName = "string",
Separator = "string",
Distinct = TRUE|FALSE
)
)
),
PivotConfiguration = list(
LabelColumnName = "string",
PivotedLabels = list(
list(
LabelName = "string",
NewColumnName = "string",
NewColumnId = "string"
)
)
)
),
UnpivotStep = list(
Alias = "string",
Source = list(
TransformOperationId = "string",
ColumnIdMappings = list(
list(
SourceColumnId = "string",
TargetColumnId = "string"
)
)
),
ColumnsToUnpivot = list(
list(
ColumnName = "string",
NewValue = "string"
)
),
UnpivotedLabelColumnName = "string",
UnpivotedLabelColumnId = "string",
UnpivotedValueColumnName = "string",
UnpivotedValueColumnId = "string"
),
AppendStep = list(
Alias = "string",
FirstSource = list(
TransformOperationId = "string",
ColumnIdMappings = list(
list(
SourceColumnId = "string",
TargetColumnId = "string"
)
)
),
SecondSource = list(
TransformOperationId = "string",
ColumnIdMappings = list(
list(
SourceColumnId = "string",
TargetColumnId = "string"
)
)
),
AppendedColumns = list(
list(
ColumnName = "string",
NewColumnId = "string"
)
)
)
)
),
DestinationTableMap = list(
list(
Alias = "string",
Source = list(
TransformOperationId = "string"
)
)
)
),
SemanticModelConfiguration = list(
TableMap = list(
list(
Alias = "string",
DestinationTableId = "string",
RowLevelPermissionConfiguration = list(
TagConfiguration = list(
Status = "ENABLED"|"DISABLED",
TagRules = list(
list(
TagKey = "string",
ColumnName = "string",
TagMultiValueDelimiter = "string",
MatchAllValue = "string"
)
),
TagRuleConfigurations = list(
list(
"string"
)
)
),
RowLevelPermissionDataSet = list(
Namespace = "string",
Arn = "string",
PermissionPolicy = "GRANT_ACCESS"|"DENY_ACCESS",
FormatVersion = "VERSION_1"|"VERSION_2",
Status = "ENABLED"|"DISABLED"
)
),
SemanticMetadata = list(
ColumnMetadata = list(
list(
ColumnNames = list(
"string"
),
ColumnProperties = list(
list(
Description = list(
Text = "string"
),
AdditionalNotes = list(
Text = "string"
),
SemanticType = list(
GeographicalRole = "COUNTRY"|"STATE"|"COUNTY"|"CITY"|"POSTCODE"|"LONGITUDE"|"LATITUDE"
)
)
)
)
)
)
)
),
SemanticMetadata = list(
list(
Description = list(
Text = "string"
),
CustomInstructions = list(
list(
InlineCustomInstruction = list(
InstructionText = "string",
UploadedDocumentMetadata = list(
Name = "string"
)
)
)
)
)
)
)
),
RequestId = "string",
Status = 123
)
Request syntax¶
svc$describe_data_set(
AwsAccountId = "string",
DataSetId = "string"
)