Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . quicksight ]



Creates an empty shared folder.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--aws-account-id <value>
--folder-id <value>
[--name <value>]
[--folder-type <value>]
[--parent-folder-arn <value>]
[--permissions <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--aws-account-id (string)

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

--folder-id (string)

The ID of the folder.

--name (string)

The name of the folder.

--folder-type (string)

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

Possible values:


--parent-folder-arn (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 .


Permission for the resource.

Principal -> (string)

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)

The IAM action to grant or revoke permissions on.


Shorthand Syntax:

Principal=string,Actions=string,string ...

JSON Syntax:

    "Principal": "string",
    "Actions": ["string", ...]

--tags (list)

Tags for the folder.


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

Key -> (string)

Tag key.

Value -> (string)

Tag value.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

    "Key": "string",
    "Value": "string"

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


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.