QuickSight / Client / create_folder

create_folder#

QuickSight.Client.create_folder(**kwargs)#

Creates an empty shared folder.

See also: AWS API Documentation

Request Syntax

response = client.create_folder(
    AwsAccountId='string',
    FolderId='string',
    Name='string',
    FolderType='SHARED'|'RESTRICTED',
    ParentFolderArn='string',
    Permissions=[
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    SharingModel='ACCOUNT'|'NAMESPACE'
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

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

  • FolderId (string) –

    [REQUIRED]

    The ID of the folder.

  • Name (string) – The name of the folder.

  • FolderType (string) – The type of folder. By default, folderType is SHARED.

  • ParentFolderArn (string) –

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

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

  • Permissions (list) –

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

    To specify no permissions, omit Permissions.

    • (dict) –

      Permission for the resource.

      • Principal (string) – [REQUIRED]

        The Amazon Resource Name (ARN) of the principal. This can be one of the following:

        • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

        • The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

        • The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)

      • Actions (list) – [REQUIRED]

        The IAM action to grant or revoke permissions on.

        • (string) –

  • Tags (list) –

    Tags for the folder.

    • (dict) –

      The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.

      • Key (string) – [REQUIRED]

        Tag key.

      • Value (string) – [REQUIRED]

        Tag value.

  • SharingModel (string) – An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ACCOUNT.

Return type:

dict

Returns:

Response Syntax

{
    'Status': 123,
    'Arn': 'string',
    'FolderId': 'string',
    'RequestId': 'string'
}

Response Structure

  • (dict) –

    • Status (integer) –

      The HTTP status of the request.

    • Arn (string) –

      The Amazon Resource Name (ARN) for the newly created folder.

    • FolderId (string) –

      The folder ID for the newly created folder.

    • RequestId (string) –

      The request ID for the newly created folder.

Exceptions