aws logo
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>

Supporting Types

GetDataSetColumnGroup

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>

GetDataSetDataSetUsageConfiguration

GetDataSetFieldFolder

Columns List<string>
Description string
FieldFoldersId string
Columns []string
Description string
FieldFoldersId string
columns List<String>
description String
fieldFoldersId String
columns string[]
description string
fieldFoldersId string
columns List<String>
description String
fieldFoldersId String

GetDataSetLogicalTableMap

GetDataSetLogicalTableMapDataTransform

GetDataSetLogicalTableMapDataTransformCastColumnTypeOperation

ColumnName string
Format string
NewColumnType string
ColumnName string
Format string
NewColumnType string
columnName String
format String
newColumnType String
columnName string
format string
newColumnType string
columnName String
format String
newColumnType String

GetDataSetLogicalTableMapDataTransformCreateColumnsOperation

GetDataSetLogicalTableMapDataTransformCreateColumnsOperationColumn

ColumnId string
ColumnName string
Expression string
ColumnId string
ColumnName string
Expression string
columnId String
columnName String
expression String
columnId string
columnName string
expression string
columnId String
columnName String
expression String

GetDataSetLogicalTableMapDataTransformFilterOperation

GetDataSetLogicalTableMapDataTransformProjectOperation

ProjectedColumns List<string>
projectedColumns List<String>
projected_columns Sequence[str]
projectedColumns List<String>

GetDataSetLogicalTableMapDataTransformRenameColumnOperation

GetDataSetLogicalTableMapDataTransformTagColumnOperation

GetDataSetLogicalTableMapDataTransformTagColumnOperationTag

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

GetDataSetLogicalTableMapSourceJoinInstruction

GetDataSetLogicalTableMapSourceJoinInstructionLeftJoinKeyProperty

uniqueKey Boolean
uniqueKey boolean
uniqueKey Boolean

GetDataSetLogicalTableMapSourceJoinInstructionRightJoinKeyProperty

uniqueKey Boolean
uniqueKey boolean
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

GetDataSetPhysicalTableMapCustomSql

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

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

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 Boolean
delimiter String
format String
startFromRow Integer
textQualifier String
containsHeader boolean
delimiter string
format string
startFromRow number
textQualifier string
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 String
formatVersion String
namespace String
permissionPolicy String
status String

GetDataSetRowLevelPermissionTagConfiguration

GetDataSetRowLevelPermissionTagConfigurationTagRule

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.