folders

Creates, updates, deletes or gets a folder resource or lists folders in a region

Overview

Name	folders
Type	Resource
Description	Definition of the AWS::QuickSight::Folder Resource Type.
Id	aws.quicksight.folders

Fields

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) for the folder.
aws_account_id	string
created_time	string	The time that the folder was created.
folder_id	string
folder_type	string
last_updated_time	string	The time that the folder was last updated.
name	string
parent_folder_arn	string
permissions	array
sharing_model	string
tags	array
region	string	AWS region.

For more information, see AWS::QuickSight::Folder.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all folders in a region.

SELECT
region,
arn,
aws_account_id,
created_time,
folder_id,
folder_type,
last_updated_time,
name,
parent_folder_arn,
permissions,
sharing_model,
tags
FROM aws.quicksight.folders
WHERE region = 'us-east-1';

Gets all properties from an individual folder.

SELECT
region,
arn,
aws_account_id,
created_time,
folder_id,
folder_type,
last_updated_time,
name,
parent_folder_arn,
permissions,
sharing_model,
tags
FROM aws.quicksight.folders
WHERE region = 'us-east-1' AND data__Identifier = '<AwsAccountId>|<FolderId>';

INSERT example

Use the following StackQL query and manifest file to create a new folder resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.quicksight.folders (
 AwsAccountId,
 FolderId,
 FolderType,
 Name,
 ParentFolderArn,
 Permissions,
 SharingModel,
 Tags,
 region
)
SELECT 
'{{ AwsAccountId }}',
 '{{ FolderId }}',
 '{{ FolderType }}',
 '{{ Name }}',
 '{{ ParentFolderArn }}',
 '{{ Permissions }}',
 '{{ SharingModel }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.quicksight.folders (
 AwsAccountId,
 FolderId,
 FolderType,
 Name,
 ParentFolderArn,
 Permissions,
 SharingModel,
 Tags,
 region
)
SELECT 
 '{{ AwsAccountId }}',
 '{{ FolderId }}',
 '{{ FolderType }}',
 '{{ Name }}',
 '{{ ParentFolderArn }}',
 '{{ Permissions }}',
 '{{ SharingModel }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: folder
    props:
      - name: AwsAccountId
        value: '{{ AwsAccountId }}'
      - name: FolderId
        value: '{{ FolderId }}'
      - name: FolderType
        value: '{{ FolderType }}'
      - name: Name
        value: '{{ Name }}'
      - name: ParentFolderArn
        value: '{{ ParentFolderArn }}'
      - name: Permissions
        value:
          - Principal: '{{ Principal }}'
            Actions:
              - '{{ Actions[0] }}'
      - name: SharingModel
        value: '{{ SharingModel }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.quicksight.folders
WHERE data__Identifier = '<AwsAccountId|FolderId>'
AND region = 'us-east-1';

Permissions

To operate on the folders resource, the following permissions are required:

Read

quicksight:DescribeFolder,
quicksight:DescribeFolderPermissions,
quicksight:ListTagsForResource

Create

quicksight:CreateFolder,
quicksight:DescribeFolder,
quicksight:UpdateFolderPermissions,
quicksight:DescribeFolderPermissions,
quicksight:TagResource,
quicksight:ListTagsForResource

Update

quicksight:DescribeFolder,
quicksight:UpdateFolder,
quicksight:DescribeFolderPermissions,
quicksight:UpdateFolderPermissions,
quicksight:ListTagsForResource,
quicksight:TagResource,
quicksight:UntagResource

Delete

quicksight:DeleteFolder

List

quicksight:ListFolders