Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. quicksight
  5. getFolder

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.quicksight.getFolder

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Definition of the AWS::QuickSight::Folder Resource Type.

Using getFolder

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 getFolder(args: GetFolderArgs, opts?: InvokeOptions): Promise<GetFolderResult>
function getFolderOutput(args: GetFolderOutputArgs, opts?: InvokeOptions): Output<GetFolderResult>
Copy
def get_folder(aws_account_id: Optional[str] = None,
               folder_id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetFolderResult
def get_folder_output(aws_account_id: Optional[pulumi.Input[str]] = None,
               folder_id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetFolderResult]
Copy
func LookupFolder(ctx *Context, args *LookupFolderArgs, opts ...InvokeOption) (*LookupFolderResult, error)
func LookupFolderOutput(ctx *Context, args *LookupFolderOutputArgs, opts ...InvokeOption) LookupFolderResultOutput
Copy

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

public static class GetFolder 
{
    public static Task<GetFolderResult> InvokeAsync(GetFolderArgs args, InvokeOptions? opts = null)
    public static Output<GetFolderResult> Invoke(GetFolderInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetFolderResult> getFolder(GetFolderArgs args, InvokeOptions options)
public static Output<GetFolderResult> getFolder(GetFolderArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:quicksight:getFolder
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AwsAccountId This property is required. string
The ID for the AWS account where you want to create the folder.
FolderId This property is required. string
The ID of the folder.
AwsAccountId This property is required. string
The ID for the AWS account where you want to create the folder.
FolderId This property is required. string
The ID of the folder.
awsAccountId This property is required. String
The ID for the AWS account where you want to create the folder.
folderId This property is required. String
The ID of the folder.
awsAccountId This property is required. string
The ID for the AWS account where you want to create the folder.
folderId This property is required. string
The ID of the folder.
aws_account_id This property is required. str
The ID for the AWS account where you want to create the folder.
folder_id This property is required. str
The ID of the folder.
awsAccountId This property is required. String
The ID for the AWS account where you want to create the folder.
folderId This property is required. String
The ID of the folder.

getFolder Result

The following output properties are available:

Arn string
CreatedTime string
LastUpdatedTime string
Name string
A display name for the folder.
Permissions List<Pulumi.AwsNative.QuickSight.Outputs.FolderResourcePermission>

A structure that describes the principals and the resource-level permissions of a folder.

To specify no permissions, omit Permissions .

Tags List<Pulumi.AwsNative.Outputs.Tag>
A list of tags for the folders that you want to apply overrides to.
Arn string
CreatedTime string
LastUpdatedTime string
Name string
A display name for the folder.
Permissions []FolderResourcePermission

A structure that describes the principals and the resource-level permissions of a folder.

To specify no permissions, omit Permissions .

Tags Tag
A list of tags for the folders that you want to apply overrides to.
arn String
createdTime String
lastUpdatedTime String
name String
A display name for the folder.
permissions List<FolderResourcePermission>

A structure that describes the principals and the resource-level permissions of a folder.

To specify no permissions, omit Permissions .

tags List<Tag>
A list of tags for the folders that you want to apply overrides to.
arn string
createdTime string
lastUpdatedTime string
name string
A display name for the folder.
permissions FolderResourcePermission[]

A structure that describes the principals and the resource-level permissions of a folder.

To specify no permissions, omit Permissions .

tags Tag[]
A list of tags for the folders that you want to apply overrides to.
arn str
created_time str
last_updated_time str
name str
A display name for the folder.
permissions Sequence[FolderResourcePermission]

A structure that describes the principals and the resource-level permissions of a folder.

To specify no permissions, omit Permissions .

tags Sequence[root_Tag]
A list of tags for the folders that you want to apply overrides to.
arn String
createdTime String
lastUpdatedTime String
name String
A display name for the folder.
permissions List<Property Map>

A structure that describes the principals and the resource-level permissions of a folder.

To specify no permissions, omit Permissions .

tags List<Property Map>
A list of tags for the folders that you want to apply overrides to.

Supporting Types

FolderResourcePermission

Actions This property is required. List<string>
Principal This property is required. string
Actions This property is required. []string
Principal This property is required. string
actions This property is required. List<String>
principal This property is required. String
actions This property is required. string[]
principal This property is required. string
actions This property is required. Sequence[str]
principal This property is required. str
actions This property is required. List<String>
principal This property is required. String

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native