folders

Creates, updates, deletes, gets or lists a folders resource.

Overview

Name	folders
Type	Resource
Id	aws.quicksight.folders

Fields

The following fields are returned by SELECT queries:

describe_folder

Name	Datatype	Description
folder	object	Information about the folder.
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of the request.

search_folders

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the folder.
created_time	string (date-time)	The time that the folder was created.
folder_id	string	The ID of the folder. (pattern: <code>[\w-]+</code>)
folder_type	string	The type of folder. (SHARED, RESTRICTED)
last_updated_time	string (date-time)	The time that the folder was last updated.
name	string	The display name of the folder.
sharing_model	string	The sharing scope of the folder. (ACCOUNT, NAMESPACE)

list_folders

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the folder.
created_time	string (date-time)	The time that the folder was created.
folder_id	string	The ID of the folder. (pattern: <code>[\w-]+</code>)
folder_type	string	The type of folder. (SHARED, RESTRICTED)
last_updated_time	string (date-time)	The time that the folder was last updated.
name	string	The display name of the folder.
sharing_model	string	The sharing scope of the folder. (ACCOUNT, NAMESPACE)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_folder	select	aws_account_id, folder_id, region		Describes a folder.
search_folders	select	aws_account_id, region		Searches the subfolders in a folder.
list_folders	select	aws_account_id, region	next-token, max-results	Lists all folders in an account.
create_folder_membership	insert	aws_account_id, folder_id, member_id, member_type, region		Adds an asset, such as a dashboard, analysis, or dataset into a folder.
create_folder	insert	aws_account_id, folder_id, region		Creates an empty shared folder.
update_folder	update	aws_account_id, folder_id, region		Updates the name of a folder.
delete_folder_membership	delete	aws_account_id, folder_id, member_id, member_type, region		Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
delete_folder	delete	aws_account_id, folder_id, region		Deletes an empty folder.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
aws_account_id	string	The ID for the Amazon Web Services account that contains the folder.
folder_id	string	The ID of the folder.
member_id	string	The ID of the asset that you want to delete.
member_type	string	The member type of the asset that you want to delete from a folder.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of results to be returned per request.
next-token	string	The token for the next set of results, or null if there are no more results.

SELECT examples

describe_folder

Describes a folder.

SELECT
folder,
request_id,
status
FROM aws.quicksight.folders
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND folder_id = '{{ folder_id }}' -- required
AND region = '{{ region }}' -- required
;

search_folders

Searches the subfolders in a folder.

SELECT
arn,
created_time,
folder_id,
folder_type,
last_updated_time,
name,
sharing_model
FROM aws.quicksight.folders
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
;

list_folders

Lists all folders in an account.

SELECT
arn,
created_time,
folder_id,
folder_type,
last_updated_time,
name,
sharing_model
FROM aws.quicksight.folders
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;

INSERT examples

create_folder_membership

Adds an asset, such as a dashboard, analysis, or dataset into a folder.

INSERT INTO aws.quicksight.folders (
aws_account_id,
folder_id,
member_id,
member_type,
region
)
SELECT 
'{{ aws_account_id }}',
'{{ folder_id }}',
'{{ member_id }}',
'{{ member_type }}',
'{{ region }}'
RETURNING
folder_member,
request_id,
status
;

create_folder

Creates an empty shared folder.

INSERT INTO aws.quicksight.folders (
Name,
FolderType,
ParentFolderArn,
Permissions,
Tags,
SharingModel,
aws_account_id,
folder_id,
region
)
SELECT 
'{{ Name }}',
'{{ FolderType }}',
'{{ ParentFolderArn }}',
'{{ Permissions }}',
'{{ Tags }}',
'{{ SharingModel }}',
'{{ aws_account_id }}',
'{{ folder_id }}',
'{{ region }}'
RETURNING
arn,
folder_id,
request_id,
status
;

Manifest

# Description fields are for documentation purposes
- name: folders
props:
  - name: aws_account_id
    value: "{{ aws_account_id }}"
    description: Required parameter for the folders resource.
  - name: folder_id
    value: "{{ folder_id }}"
    description: Required parameter for the folders resource.
  - name: member_id
    value: "{{ member_id }}"
    description: Required parameter for the folders resource.
  - name: member_type
    value: "{{ member_type }}"
    description: Required parameter for the folders resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the folders resource.
  - name: Name
    value: "{{ Name }}"
  - name: FolderType
    value: "{{ FolderType }}"
    valid_values: ['SHARED', 'RESTRICTED']
  - name: ParentFolderArn
    value: "{{ ParentFolderArn }}"
  - name: Permissions
    value:
      - Principal: "{{ Principal }}"
        Actions: "{{ Actions }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: SharingModel
    value: "{{ SharingModel }}"
    valid_values: ['ACCOUNT', 'NAMESPACE']

UPDATE examples

update_folder

Updates the name of a folder.

UPDATE aws.quicksight.folders
SET 
Name = '{{ Name }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND folder_id = '{{ folder_id }}' --required
AND region = '{{ region }}' --required
RETURNING
arn,
folder_id,
request_id,
status;

DELETE examples

delete_folder_membership

Removes an asset, such as a dashboard, analysis, or dataset, from a folder.

DELETE FROM aws.quicksight.folders
WHERE aws_account_id = '{{ aws_account_id }}' --required
AND folder_id = '{{ folder_id }}' --required
AND member_id = '{{ member_id }}' --required
AND member_type = '{{ member_type }}' --required
AND region = '{{ region }}' --required
;

delete_folder

Deletes an empty folder.

DELETE FROM aws.quicksight.folders
WHERE aws_account_id = '{{ aws_account_id }}' --required
AND folder_id = '{{ folder_id }}' --required
AND region = '{{ region }}' --required
;