Try AWS Native preview for resources not in the classic version.
aws.quicksight.getDataSet
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
Data source for managing a QuickSight Data Set.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.quicksight.getDataSet({
dataSetId: "example-id",
});
import pulumi
import pulumi_aws as aws
example = aws.quicksight.get_data_set(data_set_id="example-id")
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/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
})
}
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 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());
}
}
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,
tags_all: 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,
tags_all: 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:
- Data
Set stringId Identifier for the data set.
The following arguments are optional:
- Aws
Account stringId - AWS account ID.
- Column
Level List<Pulumi.Permission Rules Aws. Quicksight. Inputs. Get Data Set Column Level Permission Rule> - Dictionary<string, string>
- Dictionary<string, string>
- Data
Set stringId Identifier for the data set.
The following arguments are optional:
- Aws
Account stringId - AWS account ID.
- Column
Level []GetPermission Rules Data Set Column Level Permission Rule - map[string]string
- map[string]string
- data
Set StringId Identifier for the data set.
The following arguments are optional:
- aws
Account StringId - AWS account ID.
- column
Level List<GetPermission Rules Data Set Column Level Permission Rule> - Map<String,String>
- Map<String,String>
- data
Set stringId Identifier for the data set.
The following arguments are optional:
- aws
Account stringId - AWS account ID.
- column
Level GetPermission Rules Data Set Column Level Permission Rule[] - {[key: string]: string}
- {[key: string]: string}
- data_
set_ strid Identifier for the data set.
The following arguments are optional:
- aws_
account_ strid - AWS account ID.
- column_
level_ Sequence[Getpermission_ rules Data Set Column Level Permission Rule] - Mapping[str, str]
- Mapping[str, str]
- data
Set StringId Identifier for the data set.
The following arguments are optional:
- aws
Account StringId - AWS account ID.
- column
Level List<Property Map>Permission Rules - Map<String>
- Map<String>
getDataSet Result
The following output properties are available:
- Arn string
- Aws
Account stringId - Column
Groups List<Pulumi.Aws. Quicksight. Outputs. Get Data Set Column Group> - Data
Set stringId - Data
Set List<Pulumi.Usage Configurations Aws. Quicksight. Outputs. Get Data Set Data Set Usage Configuration> - Field
Folders List<Pulumi.Aws. Quicksight. Outputs. Get Data Set Field Folder> - Id string
- The provider-assigned unique ID for this managed resource.
- Import
Mode string - Logical
Table List<Pulumi.Maps Aws. Quicksight. Outputs. Get Data Set Logical Table Map> - Name string
- Permissions
List<Pulumi.
Aws. Quicksight. Outputs. Get Data Set Permission> - Physical
Table List<Pulumi.Maps Aws. Quicksight. Outputs. Get Data Set Physical Table Map> - Row
Level List<Pulumi.Permission Data Sets Aws. Quicksight. Outputs. Get Data Set Row Level Permission Data Set> - Row
Level List<Pulumi.Permission Tag Configurations Aws. Quicksight. Outputs. Get Data Set Row Level Permission Tag Configuration> - Dictionary<string, string>
- Dictionary<string, string>
- Column
Level List<Pulumi.Permission Rules Aws. Quicksight. Outputs. Get Data Set Column Level Permission Rule>
- Arn string
- Aws
Account stringId - Column
Groups []GetData Set Column Group - Data
Set stringId - Data
Set []GetUsage Configurations Data Set Data Set Usage Configuration - Field
Folders []GetData Set Field Folder - Id string
- The provider-assigned unique ID for this managed resource.
- Import
Mode string - Logical
Table []GetMaps Data Set Logical Table Map - Name string
- Permissions
[]Get
Data Set Permission - Physical
Table []GetMaps Data Set Physical Table Map - Row
Level []GetPermission Data Sets Data Set Row Level Permission Data Set - Row
Level []GetPermission Tag Configurations Data Set Row Level Permission Tag Configuration - map[string]string
- map[string]string
- Column
Level []GetPermission Rules Data Set Column Level Permission Rule
- arn String
- aws
Account StringId - column
Groups List<GetData Set Column Group> - data
Set StringId - data
Set List<GetUsage Configurations Data Set Data Set Usage Configuration> - field
Folders List<GetData Set Field Folder> - id String
- The provider-assigned unique ID for this managed resource.
- import
Mode String - logical
Table List<GetMaps Data Set Logical Table Map> - name String
- permissions
List<Get
Data Set Permission> - physical
Table List<GetMaps Data Set Physical Table Map> - row
Level List<GetPermission Data Sets Data Set Row Level Permission Data Set> - row
Level List<GetPermission Tag Configurations Data Set Row Level Permission Tag Configuration> - Map<String,String>
- Map<String,String>
- column
Level List<GetPermission Rules Data Set Column Level Permission Rule>
- arn string
- aws
Account stringId - column
Groups GetData Set Column Group[] - data
Set stringId - data
Set GetUsage Configurations Data Set Data Set Usage Configuration[] - field
Folders GetData Set Field Folder[] - id string
- The provider-assigned unique ID for this managed resource.
- import
Mode string - logical
Table GetMaps Data Set Logical Table Map[] - name string
- permissions
Get
Data Set Permission[] - physical
Table GetMaps Data Set Physical Table Map[] - row
Level GetPermission Data Sets Data Set Row Level Permission Data Set[] - row
Level GetPermission Tag Configurations Data Set Row Level Permission Tag Configuration[] - {[key: string]: string}
- {[key: string]: string}
- column
Level GetPermission Rules Data Set Column Level Permission Rule[]
- arn str
- aws_
account_ strid - column_
groups Sequence[GetData Set Column Group] - data_
set_ strid - data_
set_ Sequence[Getusage_ configurations Data Set Data Set Usage Configuration] - field_
folders Sequence[GetData Set Field Folder] - id str
- The provider-assigned unique ID for this managed resource.
- import_
mode str - logical_
table_ Sequence[Getmaps Data Set Logical Table Map] - name str
- permissions
Sequence[Get
Data Set Permission] - physical_
table_ Sequence[Getmaps Data Set Physical Table Map] - row_
level_ Sequence[Getpermission_ data_ sets Data Set Row Level Permission Data Set] - row_
level_ Sequence[Getpermission_ tag_ configurations Data Set Row Level Permission Tag Configuration] - Mapping[str, str]
- Mapping[str, str]
- column_
level_ Sequence[Getpermission_ rules Data Set Column Level Permission Rule]
- arn String
- aws
Account StringId - column
Groups List<Property Map> - data
Set StringId - data
Set List<Property Map>Usage Configurations - field
Folders List<Property Map> - id String
- The provider-assigned unique ID for this managed resource.
- import
Mode String - logical
Table List<Property Map>Maps - name String
- permissions List<Property Map>
- physical
Table List<Property Map>Maps - row
Level List<Property Map>Permission Data Sets - row
Level List<Property Map>Permission Tag Configurations - Map<String>
- Map<String>
- column
Level List<Property Map>Permission Rules
Supporting Types
GetDataSetColumnGroup
GetDataSetColumnGroupGeoSpatialColumnGroup
- Columns List<string>
- Country
Code string - Name string
- Columns []string
- Country
Code string - Name string
- columns List<String>
- country
Code String - name String
- columns string[]
- country
Code string - name string
- columns Sequence[str]
- country_
code str - name str
- columns List<String>
- country
Code String - name String
GetDataSetColumnLevelPermissionRule
- Column
Names List<string> - Principals List<string>
- Column
Names []string - Principals []string
- column
Names List<String> - principals List<String>
- column
Names string[] - principals string[]
- column_
names Sequence[str] - principals Sequence[str]
- column
Names List<String> - principals List<String>
GetDataSetDataSetUsageConfiguration
- disable
Use BooleanAs Direct Query Source - disable
Use BooleanAs Imported Source
- disable
Use booleanAs Direct Query Source - disable
Use booleanAs Imported Source
- disable
Use BooleanAs Direct Query Source - disable
Use BooleanAs Imported Source
GetDataSetFieldFolder
- Columns List<string>
- Description string
- Field
Folders stringId
- Columns []string
- Description string
- Field
Folders stringId
- columns List<String>
- description String
- field
Folders StringId
- columns string[]
- description string
- field
Folders stringId
- columns Sequence[str]
- description str
- field_
folders_ strid
- columns List<String>
- description String
- field
Folders StringId
GetDataSetLogicalTableMap
GetDataSetLogicalTableMapDataTransform
- Cast
Column List<Pulumi.Type Operations Aws. Quicksight. Inputs. Get Data Set Logical Table Map Data Transform Cast Column Type Operation> - Create
Columns List<Pulumi.Operations Aws. Quicksight. Inputs. Get Data Set Logical Table Map Data Transform Create Columns Operation> - Filter
Operations List<Pulumi.Aws. Quicksight. Inputs. Get Data Set Logical Table Map Data Transform Filter Operation> - Project
Operations List<Pulumi.Aws. Quicksight. Inputs. Get Data Set Logical Table Map Data Transform Project Operation> - Rename
Column List<Pulumi.Operations Aws. Quicksight. Inputs. Get Data Set Logical Table Map Data Transform Rename Column Operation> - Tag
Column List<Pulumi.Operations Aws. Quicksight. Inputs. Get Data Set Logical Table Map Data Transform Tag Column Operation> - Untag
Column List<Pulumi.Operations Aws. Quicksight. Inputs. Get Data Set Logical Table Map Data Transform Untag Column Operation>
- Cast
Column []GetType Operations Data Set Logical Table Map Data Transform Cast Column Type Operation - Create
Columns []GetOperations Data Set Logical Table Map Data Transform Create Columns Operation - Filter
Operations []GetData Set Logical Table Map Data Transform Filter Operation - Project
Operations []GetData Set Logical Table Map Data Transform Project Operation - Rename
Column []GetOperations Data Set Logical Table Map Data Transform Rename Column Operation - Tag
Column []GetOperations Data Set Logical Table Map Data Transform Tag Column Operation - Untag
Column []GetOperations Data Set Logical Table Map Data Transform Untag Column Operation
- cast
Column List<GetType Operations Data Set Logical Table Map Data Transform Cast Column Type Operation> - create
Columns List<GetOperations Data Set Logical Table Map Data Transform Create Columns Operation> - filter
Operations List<GetData Set Logical Table Map Data Transform Filter Operation> - project
Operations List<GetData Set Logical Table Map Data Transform Project Operation> - rename
Column List<GetOperations Data Set Logical Table Map Data Transform Rename Column Operation> - tag
Column List<GetOperations Data Set Logical Table Map Data Transform Tag Column Operation> - untag
Column List<GetOperations Data Set Logical Table Map Data Transform Untag Column Operation>
- cast
Column GetType Operations Data Set Logical Table Map Data Transform Cast Column Type Operation[] - create
Columns GetOperations Data Set Logical Table Map Data Transform Create Columns Operation[] - filter
Operations GetData Set Logical Table Map Data Transform Filter Operation[] - project
Operations GetData Set Logical Table Map Data Transform Project Operation[] - rename
Column GetOperations Data Set Logical Table Map Data Transform Rename Column Operation[] - tag
Column GetOperations Data Set Logical Table Map Data Transform Tag Column Operation[] - untag
Column GetOperations Data Set Logical Table Map Data Transform Untag Column Operation[]
- cast_
column_ Sequence[Gettype_ operations Data Set Logical Table Map Data Transform Cast Column Type Operation] - create_
columns_ Sequence[Getoperations Data Set Logical Table Map Data Transform Create Columns Operation] - filter_
operations Sequence[GetData Set Logical Table Map Data Transform Filter Operation] - project_
operations Sequence[GetData Set Logical Table Map Data Transform Project Operation] - rename_
column_ Sequence[Getoperations Data Set Logical Table Map Data Transform Rename Column Operation] - tag_
column_ Sequence[Getoperations Data Set Logical Table Map Data Transform Tag Column Operation] - untag_
column_ Sequence[Getoperations Data Set Logical Table Map Data Transform Untag Column Operation]
GetDataSetLogicalTableMapDataTransformCastColumnTypeOperation
- Column
Name string - Format string
- New
Column stringType
- Column
Name string - Format string
- New
Column stringType
- column
Name String - format String
- new
Column StringType
- column
Name string - format string
- new
Column stringType
- column_
name str - format str
- new_
column_ strtype
- column
Name String - format String
- new
Column StringType
GetDataSetLogicalTableMapDataTransformCreateColumnsOperation
GetDataSetLogicalTableMapDataTransformCreateColumnsOperationColumn
- Column
Id string - Column
Name string - Expression string
- Column
Id string - Column
Name string - Expression string
- column
Id String - column
Name String - expression String
- column
Id string - column
Name string - expression string
- column_
id str - column_
name str - expression str
- column
Id String - column
Name String - expression String
GetDataSetLogicalTableMapDataTransformFilterOperation
- Condition
Expression string
- Condition
Expression string
- condition
Expression String
- condition
Expression string
- condition
Expression String
GetDataSetLogicalTableMapDataTransformProjectOperation
- Projected
Columns List<string>
- Projected
Columns []string
- projected
Columns List<String>
- projected
Columns string[]
- projected_
columns Sequence[str]
- projected
Columns List<String>
GetDataSetLogicalTableMapDataTransformRenameColumnOperation
- Column
Name string - New
Column stringName
- Column
Name string - New
Column stringName
- column
Name String - new
Column StringName
- column
Name string - new
Column stringName
- column_
name str - new_
column_ strname
- column
Name String - new
Column StringName
GetDataSetLogicalTableMapDataTransformTagColumnOperation
- column
Name String - List<Property Map>
GetDataSetLogicalTableMapDataTransformTagColumnOperationTag
GetDataSetLogicalTableMapDataTransformTagColumnOperationTagColumnDescription
- Text string
- Text string
- text String
- text string
- text str
- text String
GetDataSetLogicalTableMapDataTransformUntagColumnOperation
- Column
Name string - Tag
Names List<string>
- Column
Name string - Tag
Names []string
- column
Name String - tag
Names List<String>
- column
Name string - tag
Names string[]
- column_
name str - tag_
names Sequence[str]
- column
Name String - tag
Names List<String>
GetDataSetLogicalTableMapSource
- data
Set StringArn - join
Instructions List<Property Map> - physical
Table StringId
GetDataSetLogicalTableMapSourceJoinInstruction
- Left
Join List<Pulumi.Key Properties Aws. Quicksight. Inputs. Get Data Set Logical Table Map Source Join Instruction Left Join Key Property> - Left
Operand string - On
Clause string - Right
Join List<Pulumi.Key Properties Aws. Quicksight. Inputs. Get Data Set Logical Table Map Source Join Instruction Right Join Key Property> - Right
Operand string - Type string
- left
Join List<Property Map>Key Properties - left
Operand String - on
Clause String - right
Join List<Property Map>Key Properties - right
Operand String - type String
GetDataSetLogicalTableMapSourceJoinInstructionLeftJoinKeyProperty
- Unique
Key bool
- Unique
Key bool
- unique
Key Boolean
- unique
Key boolean
- unique_
key bool
- unique
Key Boolean
GetDataSetLogicalTableMapSourceJoinInstructionRightJoinKeyProperty
- Unique
Key bool
- Unique
Key bool
- unique
Key Boolean
- unique
Key boolean
- unique_
key bool
- unique
Key Boolean
GetDataSetPermission
GetDataSetPhysicalTableMap
GetDataSetPhysicalTableMapCustomSql
- Columns
[]Get
Data Set Physical Table Map Custom Sql Column - Data
Source stringArn - Name string
- Sql
Query string
- columns
List<Get
Data Set Physical Table Map Custom Sql Column> - data
Source StringArn - name String
- sql
Query String
- columns
Get
Data Set Physical Table Map Custom Sql Column[] - data
Source stringArn - name string
- sql
Query string
- columns List<Property Map>
- data
Source StringArn - name String
- sql
Query String
GetDataSetPhysicalTableMapCustomSqlColumn
GetDataSetPhysicalTableMapRelationalTable
- Catalog string
- Data
Source stringArn - Input
Columns []GetData Set Physical Table Map Relational Table Input Column - Name string
- Schema string
- catalog String
- data
Source StringArn - input
Columns List<GetData Set Physical Table Map Relational Table Input Column> - name String
- schema String
- catalog string
- data
Source stringArn - input
Columns GetData Set Physical Table Map Relational Table Input Column[] - name string
- schema string
- catalog String
- data
Source StringArn - input
Columns List<Property Map> - name String
- schema String
GetDataSetPhysicalTableMapRelationalTableInputColumn
GetDataSetPhysicalTableMapS3Source
GetDataSetPhysicalTableMapS3SourceInputColumn
GetDataSetPhysicalTableMapS3SourceUploadSetting
- Contains
Header bool - Delimiter string
- Format string
- Start
From intRow - Text
Qualifier string
- Contains
Header bool - Delimiter string
- Format string
- Start
From intRow - Text
Qualifier string
- contains
Header Boolean - delimiter String
- format String
- start
From IntegerRow - text
Qualifier String
- contains
Header boolean - delimiter string
- format string
- start
From numberRow - text
Qualifier string
- contains_
header bool - delimiter str
- format str
- start_
from_ introw - text_
qualifier str
- contains
Header Boolean - delimiter String
- format String
- start
From NumberRow - text
Qualifier String
GetDataSetRowLevelPermissionDataSet
- Arn string
- Format
Version string - Namespace string
- Permission
Policy string - Status string
- Arn string
- Format
Version string - Namespace string
- Permission
Policy string - Status string
- arn String
- format
Version String - namespace String
- permission
Policy String - status String
- arn string
- format
Version string - namespace string
- permission
Policy string - status string
- arn str
- format_
version str - namespace str
- permission_
policy str - status str
- arn String
- format
Version String - namespace String
- permission
Policy String - status String
GetDataSetRowLevelPermissionTagConfiguration
- status String
- tag
Rules List<Property Map>
GetDataSetRowLevelPermissionTagConfigurationTagRule
- Column
Name string - Match
All stringValue - Tag
Key string - Tag
Multi stringValue Delimiter
- Column
Name string - Match
All stringValue - Tag
Key string - Tag
Multi stringValue Delimiter
- column
Name String - match
All StringValue - tag
Key String - tag
Multi StringValue Delimiter
- column
Name string - match
All stringValue - tag
Key string - tag
Multi stringValue Delimiter
- column_
name str - match_
all_ strvalue - tag_
key str - tag_
multi_ strvalue_ delimiter
- column
Name String - match
All StringValue - tag
Key String - tag
Multi StringValue Delimiter
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.
Try AWS Native preview for resources not in the classic version.