AWS Classic v5.41.0, May 15 23

aws.quicksight.getDataSet

Explore with Pulumi AI

Data source for managing a QuickSight Data Set.

Example Usage

Basic Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Quicksight.GetDataSet.Invoke(new()
    {
        DataSetId = "example-id",
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/quicksight"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := quicksight.LookupDataSet(ctx, &quicksight.LookupDataSetArgs{
			DataSetId: "example-id",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.quicksight.QuicksightFunctions;
import com.pulumi.aws.quicksight.inputs.GetDataSetArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = QuicksightFunctions.getDataSet(GetDataSetArgs.builder()
            .dataSetId("example-id")
            .build());

    }
}

import pulumi
import pulumi_aws as aws

example = aws.quicksight.get_data_set(data_set_id="example-id")

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.quicksight.getDataSet({
    dataSetId: "example-id",
});

variables:
  example:
    fn::invoke:
      Function: aws:quicksight:getDataSet
      Arguments:
        dataSetId: example-id

Using getDataSet

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDataSet(args: GetDataSetArgs, opts?: InvokeOptions): Promise<GetDataSetResult>
function getDataSetOutput(args: GetDataSetOutputArgs, opts?: InvokeOptions): Output<GetDataSetResult>

def get_data_set(aws_account_id: Optional[str] = None,
                 column_level_permission_rules: Optional[Sequence[GetDataSetColumnLevelPermissionRule]] = None,
                 data_set_id: Optional[str] = None,
                 tags: Optional[Mapping[str, str]] = None,
                 opts: Optional[InvokeOptions] = None) -> GetDataSetResult
def get_data_set_output(aws_account_id: Optional[pulumi.Input[str]] = None,
                 column_level_permission_rules: Optional[pulumi.Input[Sequence[pulumi.Input[GetDataSetColumnLevelPermissionRuleArgs]]]] = None,
                 data_set_id: Optional[pulumi.Input[str]] = None,
                 tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetDataSetResult]

func LookupDataSet(ctx *Context, args *LookupDataSetArgs, opts ...InvokeOption) (*LookupDataSetResult, error)
func LookupDataSetOutput(ctx *Context, args *LookupDataSetOutputArgs, opts ...InvokeOption) LookupDataSetResultOutput

> Note: This function is named LookupDataSet in the Go SDK.

public static class GetDataSet 
{
    public static Task<GetDataSetResult> InvokeAsync(GetDataSetArgs args, InvokeOptions? opts = null)
    public static Output<GetDataSetResult> Invoke(GetDataSetInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDataSetResult> getDataSet(GetDataSetArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws:quicksight/getDataSet:getDataSet
  arguments:
    # arguments dictionary

The following arguments are supported:

DataSetId string: Identifier for the data set.
AwsAccountId string: AWS account ID.
ColumnLevelPermissionRules List<Pulumi.Aws.Quicksight.Inputs.GetDataSetColumnLevelPermissionRule>
Tags Dictionary<string, string>

DataSetId string: Identifier for the data set.
AwsAccountId string: AWS account ID.
ColumnLevelPermissionRules []GetDataSetColumnLevelPermissionRule
Tags map[string]string

dataSetId String: Identifier for the data set.
awsAccountId String: AWS account ID.
columnLevelPermissionRules List<GetDataSetColumnLevelPermissionRule>
tags Map<String,String>

dataSetId string: Identifier for the data set.
awsAccountId string: AWS account ID.
columnLevelPermissionRules GetDataSetColumnLevelPermissionRule[]
tags {[key: string]: string}

data_set_id str: Identifier for the data set.
aws_account_id str: AWS account ID.
column_level_permission_rules Sequence[GetDataSetColumnLevelPermissionRule]
tags Mapping[str, str]

dataSetId String: Identifier for the data set.
awsAccountId String: AWS account ID.
columnLevelPermissionRules List<Property Map>
tags Map<String>

getDataSet Result

The following output properties are available:

Arn string
AwsAccountId string
ColumnGroups List<Pulumi.Aws.Quicksight.Outputs.GetDataSetColumnGroup>
DataSetId string
DataSetUsageConfigurations List<Pulumi.Aws.Quicksight.Outputs.GetDataSetDataSetUsageConfiguration>
FieldFolders List<Pulumi.Aws.Quicksight.Outputs.GetDataSetFieldFolder>
Id string: The provider-assigned unique ID for this managed resource.
ImportMode string
LogicalTableMaps List<Pulumi.Aws.Quicksight.Outputs.GetDataSetLogicalTableMap>
Name string
Permissions List<Pulumi.Aws.Quicksight.Outputs.GetDataSetPermission>
PhysicalTableMaps List<Pulumi.Aws.Quicksight.Outputs.GetDataSetPhysicalTableMap>
RowLevelPermissionDataSets List<Pulumi.Aws.Quicksight.Outputs.GetDataSetRowLevelPermissionDataSet>
RowLevelPermissionTagConfigurations List<Pulumi.Aws.Quicksight.Outputs.GetDataSetRowLevelPermissionTagConfiguration>
Tags Dictionary<string, string>
TagsAll Dictionary<string, string>
ColumnLevelPermissionRules List<Pulumi.Aws.Quicksight.Outputs.GetDataSetColumnLevelPermissionRule>

Arn string
AwsAccountId string
ColumnGroups []GetDataSetColumnGroup
DataSetId string
DataSetUsageConfigurations []GetDataSetDataSetUsageConfiguration
FieldFolders []GetDataSetFieldFolder
Id string: The provider-assigned unique ID for this managed resource.
ImportMode string
LogicalTableMaps []GetDataSetLogicalTableMap
Name string
Permissions []GetDataSetPermission
PhysicalTableMaps []GetDataSetPhysicalTableMap
RowLevelPermissionDataSets []GetDataSetRowLevelPermissionDataSet
RowLevelPermissionTagConfigurations []GetDataSetRowLevelPermissionTagConfiguration
Tags map[string]string
TagsAll map[string]string
ColumnLevelPermissionRules []GetDataSetColumnLevelPermissionRule

arn String
awsAccountId String
columnGroups List<GetDataSetColumnGroup>
dataSetId String
dataSetUsageConfigurations List<GetDataSetDataSetUsageConfiguration>
fieldFolders List<GetDataSetFieldFolder>
id String: The provider-assigned unique ID for this managed resource.
importMode String
logicalTableMaps List<GetDataSetLogicalTableMap>
name String
permissions List<GetDataSetPermission>
physicalTableMaps List<GetDataSetPhysicalTableMap>
rowLevelPermissionDataSets List<GetDataSetRowLevelPermissionDataSet>
rowLevelPermissionTagConfigurations List<GetDataSetRowLevelPermissionTagConfiguration>
tags Map<String,String>
tagsAll Map<String,String>
columnLevelPermissionRules List<GetDataSetColumnLevelPermissionRule>

arn string
awsAccountId string
columnGroups GetDataSetColumnGroup[]
dataSetId string
dataSetUsageConfigurations GetDataSetDataSetUsageConfiguration[]
fieldFolders GetDataSetFieldFolder[]
id string: The provider-assigned unique ID for this managed resource.
importMode string
logicalTableMaps GetDataSetLogicalTableMap[]
name string
permissions GetDataSetPermission[]
physicalTableMaps GetDataSetPhysicalTableMap[]
rowLevelPermissionDataSets GetDataSetRowLevelPermissionDataSet[]
rowLevelPermissionTagConfigurations GetDataSetRowLevelPermissionTagConfiguration[]
tags {[key: string]: string}
tagsAll {[key: string]: string}
columnLevelPermissionRules GetDataSetColumnLevelPermissionRule[]

arn String
awsAccountId String
columnGroups List<Property Map>
dataSetId String
dataSetUsageConfigurations List<Property Map>
fieldFolders List<Property Map>
id String: The provider-assigned unique ID for this managed resource.
importMode String
logicalTableMaps List<Property Map>
name String
permissions List<Property Map>
physicalTableMaps List<Property Map>
rowLevelPermissionDataSets List<Property Map>
rowLevelPermissionTagConfigurations List<Property Map>
tags Map<String>
tagsAll Map<String>
columnLevelPermissionRules List<Property Map>

Supporting Types

GetDataSetColumnGroup

GeoSpatialColumnGroups List<Pulumi.Aws.Quicksight.Inputs.GetDataSetColumnGroupGeoSpatialColumnGroup>

GeoSpatialColumnGroups []GetDataSetColumnGroupGeoSpatialColumnGroup

geoSpatialColumnGroups List<GetDataSetColumnGroupGeoSpatialColumnGroup>

geoSpatialColumnGroups GetDataSetColumnGroupGeoSpatialColumnGroup[]

geo_spatial_column_groups Sequence[GetDataSetColumnGroupGeoSpatialColumnGroup]

geoSpatialColumnGroups List<Property Map>

GetDataSetColumnGroupGeoSpatialColumnGroup

Columns List<string>
CountryCode string
Name string

Columns []string
CountryCode string
Name string

columns List<String>
countryCode String
name String

columns string[]
countryCode string
name string

columns Sequence[str]
country_code str
name str

columns List<String>
countryCode String
name String

GetDataSetColumnLevelPermissionRule

ColumnNames List<string>
Principals List<string>

ColumnNames []string
Principals []string

columnNames List<String>
principals List<String>

columnNames string[]
principals string[]

column_names Sequence[str]
principals Sequence[str]

columnNames List<String>
principals List<String>

GetDataSetLogicalTableMapDataTransformTagColumnOperationTagColumnDescription

Text string

Text string

text String

text string

text str

text String

GetDataSetLogicalTableMapDataTransformUntagColumnOperation

ColumnName string
TagNames List<string>

ColumnName string
TagNames []string

columnName String
tagNames List<String>

columnName string
tagNames string[]

column_name str
tag_names Sequence[str]

columnName String
tagNames List<String>

GetDataSetLogicalTableMapSource

DataSetArn string
JoinInstructions List<Pulumi.Aws.Quicksight.Inputs.GetDataSetLogicalTableMapSourceJoinInstruction>
PhysicalTableId string

DataSetArn string
JoinInstructions []GetDataSetLogicalTableMapSourceJoinInstruction
PhysicalTableId string

dataSetArn String
joinInstructions List<GetDataSetLogicalTableMapSourceJoinInstruction>
physicalTableId String

dataSetArn string
joinInstructions GetDataSetLogicalTableMapSourceJoinInstruction[]
physicalTableId string

data_set_arn str
join_instructions Sequence[GetDataSetLogicalTableMapSourceJoinInstruction]
physical_table_id str

dataSetArn String
joinInstructions List<Property Map>
physicalTableId String

GetDataSetLogicalTableMapSourceJoinInstruction

LeftJoinKeyProperties List<Pulumi.Aws.Quicksight.Inputs.GetDataSetLogicalTableMapSourceJoinInstructionLeftJoinKeyProperty>
LeftOperand string
OnClause string
RightJoinKeyProperties List<Pulumi.Aws.Quicksight.Inputs.GetDataSetLogicalTableMapSourceJoinInstructionRightJoinKeyProperty>
RightOperand string
Type string

LeftJoinKeyProperties []GetDataSetLogicalTableMapSourceJoinInstructionLeftJoinKeyProperty
LeftOperand string
OnClause string
RightJoinKeyProperties []GetDataSetLogicalTableMapSourceJoinInstructionRightJoinKeyProperty
RightOperand string
Type string

leftJoinKeyProperties List<GetDataSetLogicalTableMapSourceJoinInstructionLeftJoinKeyProperty>
leftOperand String
onClause String
rightJoinKeyProperties List<GetDataSetLogicalTableMapSourceJoinInstructionRightJoinKeyProperty>
rightOperand String
type String

leftJoinKeyProperties GetDataSetLogicalTableMapSourceJoinInstructionLeftJoinKeyProperty[]
leftOperand string
onClause string
rightJoinKeyProperties GetDataSetLogicalTableMapSourceJoinInstructionRightJoinKeyProperty[]
rightOperand string
type string

left_join_key_properties Sequence[GetDataSetLogicalTableMapSourceJoinInstructionLeftJoinKeyProperty]
left_operand str
on_clause str
right_join_key_properties Sequence[GetDataSetLogicalTableMapSourceJoinInstructionRightJoinKeyProperty]
right_operand str
type str

leftJoinKeyProperties List<Property Map>
leftOperand String
onClause String
rightJoinKeyProperties List<Property Map>
rightOperand String
type String

GetDataSetLogicalTableMapSourceJoinInstructionLeftJoinKeyProperty

UniqueKey bool

UniqueKey bool

uniqueKey Boolean

uniqueKey boolean

unique_key bool

uniqueKey Boolean

GetDataSetLogicalTableMapSourceJoinInstructionRightJoinKeyProperty

UniqueKey bool

UniqueKey bool

uniqueKey Boolean

uniqueKey boolean

unique_key bool

uniqueKey Boolean

GetDataSetPermission

Actions List<string>
Principal string

Actions []string
Principal string

actions List<String>
principal String

actions string[]
principal string

actions Sequence[str]
principal str

actions List<String>
principal String

GetDataSetPhysicalTableMap

CustomSqls List<Pulumi.Aws.Quicksight.Inputs.GetDataSetPhysicalTableMapCustomSql>
PhysicalTableMapId string
RelationalTables List<Pulumi.Aws.Quicksight.Inputs.GetDataSetPhysicalTableMapRelationalTable>
S3Sources List<Pulumi.Aws.Quicksight.Inputs.GetDataSetPhysicalTableMapS3Source>

CustomSqls []GetDataSetPhysicalTableMapCustomSql
PhysicalTableMapId string
RelationalTables []GetDataSetPhysicalTableMapRelationalTable
S3Sources []GetDataSetPhysicalTableMapS3Source

customSqls List<GetDataSetPhysicalTableMapCustomSql>
physicalTableMapId String
relationalTables List<GetDataSetPhysicalTableMapRelationalTable>
s3Sources List<GetDataSetPhysicalTableMapS3Source>

customSqls GetDataSetPhysicalTableMapCustomSql[]
physicalTableMapId string
relationalTables GetDataSetPhysicalTableMapRelationalTable[]
s3Sources GetDataSetPhysicalTableMapS3Source[]

custom_sqls Sequence[GetDataSetPhysicalTableMapCustomSql]
physical_table_map_id str
relational_tables Sequence[GetDataSetPhysicalTableMapRelationalTable]
s3_sources Sequence[GetDataSetPhysicalTableMapS3Source]

customSqls List<Property Map>
physicalTableMapId String
relationalTables List<Property Map>
s3Sources List<Property Map>

GetDataSetPhysicalTableMapCustomSql

Columns List<Pulumi.Aws.Quicksight.Inputs.GetDataSetPhysicalTableMapCustomSqlColumn>
DataSourceArn string
Name string
SqlQuery string

Columns []GetDataSetPhysicalTableMapCustomSqlColumn
DataSourceArn string
Name string
SqlQuery string

columns List<GetDataSetPhysicalTableMapCustomSqlColumn>
dataSourceArn String
name String
sqlQuery String

columns GetDataSetPhysicalTableMapCustomSqlColumn[]
dataSourceArn string
name string
sqlQuery string

columns Sequence[GetDataSetPhysicalTableMapCustomSqlColumn]
data_source_arn str
name str
sql_query str

columns List<Property Map>
dataSourceArn String
name String
sqlQuery String

GetDataSetPhysicalTableMapCustomSqlColumn

Name string
Type string

Name string
Type string

name String
type String

name string
type string

name str
type str

name String
type String

GetDataSetPhysicalTableMapRelationalTable

Catalog string
DataSourceArn string
InputColumns List<Pulumi.Aws.Quicksight.Inputs.GetDataSetPhysicalTableMapRelationalTableInputColumn>
Name string
Schema string

Catalog string
DataSourceArn string
InputColumns []GetDataSetPhysicalTableMapRelationalTableInputColumn
Name string
Schema string

catalog String
dataSourceArn String
inputColumns List<GetDataSetPhysicalTableMapRelationalTableInputColumn>
name String
schema String

catalog string
dataSourceArn string
inputColumns GetDataSetPhysicalTableMapRelationalTableInputColumn[]
name string
schema string

catalog str
data_source_arn str
input_columns Sequence[GetDataSetPhysicalTableMapRelationalTableInputColumn]
name str
schema str

catalog String
dataSourceArn String
inputColumns List<Property Map>
name String
schema String

GetDataSetPhysicalTableMapRelationalTableInputColumn

Name string
Type string

Name string
Type string

name String
type String

name string
type string

name str
type str

name String
type String

GetDataSetPhysicalTableMapS3Source

DataSourceArn string
InputColumns List<Pulumi.Aws.Quicksight.Inputs.GetDataSetPhysicalTableMapS3SourceInputColumn>
UploadSettings List<Pulumi.Aws.Quicksight.Inputs.GetDataSetPhysicalTableMapS3SourceUploadSetting>

DataSourceArn string
InputColumns []GetDataSetPhysicalTableMapS3SourceInputColumn
UploadSettings []GetDataSetPhysicalTableMapS3SourceUploadSetting

dataSourceArn String
inputColumns List<GetDataSetPhysicalTableMapS3SourceInputColumn>
uploadSettings List<GetDataSetPhysicalTableMapS3SourceUploadSetting>

dataSourceArn string
inputColumns GetDataSetPhysicalTableMapS3SourceInputColumn[]
uploadSettings GetDataSetPhysicalTableMapS3SourceUploadSetting[]

data_source_arn str
input_columns Sequence[GetDataSetPhysicalTableMapS3SourceInputColumn]
upload_settings Sequence[GetDataSetPhysicalTableMapS3SourceUploadSetting]

dataSourceArn String
inputColumns List<Property Map>
uploadSettings List<Property Map>

GetDataSetPhysicalTableMapS3SourceInputColumn

Name string
Type string

Name string
Type string

name String
type String

name string
type string

name str
type str

name String
type String

GetDataSetPhysicalTableMapS3SourceUploadSetting

ContainsHeader bool
Delimiter string
Format string
StartFromRow int
TextQualifier string

ContainsHeader bool
Delimiter string
Format string
StartFromRow int
TextQualifier string

containsHeader Boolean
delimiter String
format String
startFromRow Integer
textQualifier String

containsHeader boolean
delimiter string
format string
startFromRow number
textQualifier string

contains_header bool
delimiter str
format str
start_from_row int
text_qualifier str

containsHeader Boolean
delimiter String
format String
startFromRow Number
textQualifier String

GetDataSetRowLevelPermissionDataSet

Arn string
FormatVersion string
Namespace string
PermissionPolicy string
Status string

Arn string
FormatVersion string
Namespace string
PermissionPolicy string
Status string

arn String
formatVersion String
namespace String
permissionPolicy String
status String

arn string
formatVersion string
namespace string
permissionPolicy string
status string

arn str
format_version str
namespace str
permission_policy str
status str

arn String
formatVersion String
namespace String
permissionPolicy String
status String

GetDataSetRowLevelPermissionTagConfiguration

Status string
TagRules List<Pulumi.Aws.Quicksight.Inputs.GetDataSetRowLevelPermissionTagConfigurationTagRule>

Status string
TagRules []GetDataSetRowLevelPermissionTagConfigurationTagRule

status String
tagRules List<GetDataSetRowLevelPermissionTagConfigurationTagRule>

status string
tagRules GetDataSetRowLevelPermissionTagConfigurationTagRule[]

status str
tag_rules Sequence[GetDataSetRowLevelPermissionTagConfigurationTagRule]

status String
tagRules List<Property Map>

GetDataSetRowLevelPermissionTagConfigurationTagRule

ColumnName string
MatchAllValue string
TagKey string
TagMultiValueDelimiter string

ColumnName string
MatchAllValue string
TagKey string
TagMultiValueDelimiter string

columnName String
matchAllValue String
tagKey String
tagMultiValueDelimiter String

columnName string
matchAllValue string
tagKey string
tagMultiValueDelimiter string

column_name str
match_all_value str
tag_key str
tag_multi_value_delimiter str

columnName String
matchAllValue String
tagKey String
tagMultiValueDelimiter String

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

aws.quicksight.getDataSet

Example Usage

Basic Usage

Using getDataSet

getDataSet Result

Supporting Types

GetDataSetColumnGroup

GetDataSetColumnGroupGeoSpatialColumnGroup

GetDataSetColumnLevelPermissionRule

GetDataSetDataSetUsageConfiguration

GetDataSetFieldFolder

GetDataSetLogicalTableMap

GetDataSetLogicalTableMapDataTransform

GetDataSetLogicalTableMapDataTransformCastColumnTypeOperation

GetDataSetLogicalTableMapDataTransformCreateColumnsOperation

GetDataSetLogicalTableMapDataTransformCreateColumnsOperationColumn

GetDataSetLogicalTableMapDataTransformFilterOperation

GetDataSetLogicalTableMapDataTransformProjectOperation

GetDataSetLogicalTableMapDataTransformRenameColumnOperation

GetDataSetLogicalTableMapDataTransformTagColumnOperation

GetDataSetLogicalTableMapDataTransformTagColumnOperationTag