Skip to content

CreateFolderRequest

Source code in docs_src/capo_quicksight/types/create_folder_request.py
class CreateFolderRequest(TypedDict, closed=True):
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId"
    """<p>The ID for the Amazon Web Services account where you want to create the folder.</p>"""
    folder_id: "capo_quicksight.types.restrictive_resource_id.RestrictiveResourceId"
    """<p>The ID of the folder.</p>"""
    name: NotRequired["capo_quicksight.types.folder_name.FolderName"]
    """<p>The name of the folder.</p>"""
    folder_type: NotRequired["capo_quicksight.types.folder_type.FolderType"]
    """<p>The type of folder. By default, <code>folderType</code> is <code>SHARED</code>.</p>"""
    parent_folder_arn: NotRequired["capo_quicksight.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) for the parent folder.</p> <p> <code>ParentFolderArn</code> can be null. An empty <code>parentFolderArn</code> creates a root-level folder.</p>"""
    permissions: NotRequired[
        "capo_quicksight.types.resource_permission_list.ResourcePermissionList"
    ]
    """<p>A structure that describes the principals and the resource-level permissions of a folder.</p> <p>To specify no permissions, omit <code>Permissions</code>.</p>"""
    tags: NotRequired["capo_quicksight.types.tag_list.TagList"]
    """<p>Tags for the folder.</p>"""
    sharing_model: NotRequired["capo_quicksight.types.sharing_model.SharingModel"]
    """<p>An optional parameter that determines the sharing scope of the folder. The default value for this parameter is <code>ACCOUNT</code>.</p>"""

aws_account_id instance-attribute

aws_account_id: AwsAccountId

The ID for the Amazon Web Services account where you want to create the folder.

folder_id instance-attribute

The ID of the folder.

folder_type instance-attribute

folder_type: NotRequired[FolderType]

The type of folder. By default, folderType is SHARED.

name instance-attribute

name: NotRequired[FolderName]

The name of the folder.

parent_folder_arn instance-attribute

parent_folder_arn: NotRequired[Arn]

The Amazon Resource Name (ARN) for the parent folder.

ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.

permissions instance-attribute

permissions: NotRequired[ResourcePermissionList]

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

To specify no permissions, omit Permissions.

sharing_model instance-attribute

sharing_model: NotRequired[SharingModel]

An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ACCOUNT.

tags instance-attribute

tags: NotRequired[TagList]

Tags for the folder.