Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateFolder

Creates an empty shared folder.

Request Syntax


POST /accounts/AwsAccountId/folders/FolderId HTTP/1.1
Content-type: application/json

{
   "FolderType": "string",
   "Name": "string",
   "ParentFolderArn": "string",
   "Permissions": [ 
      { 
         "Actions": [ "string" ],
         "Principal": "string"
      }
   ],
   "SharingModel": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The ID for the AWS account where you want to create the folder.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

FolderId

The ID of the folder.

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [\w\-]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

FolderType

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

Type: String

Valid Values: SHARED | RESTRICTED

Required: No

Name

The name of the folder.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Required: No

ParentFolderArn

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

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

Type: String

Required: No

Permissions

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

To specify no permissions, omit Permissions.

Type: Array of ResourcePermission objects

Array Members: Minimum number of 1 item. Maximum number of 64 items.

Required: No

SharingModel

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

Type: String

Valid Values: ACCOUNT | NAMESPACE

Required: No

Tags

Tags for the folder.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 200 items.

Required: No

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "Arn": "string",
   "FolderId": "string",
   "RequestId": "string"
}

Response Elements

If the action is successful, the service sends back the following HTTP response.

Status: The HTTP status of the request.

The following data is returned in JSON format by the service.

Arn

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

Type: String

FolderId

The folder ID for the newly created folder.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [\w\-]+

RequestId

The request ID for the newly created folder.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.

HTTP Status Code: 401

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameters has a value that isn't valid.

HTTP Status Code: 400

LimitExceededException

A limit is exceeded.

HTTP Status Code: 409

ResourceExistsException

The resource specified already exists.

HTTP Status Code: 409

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ThrottlingException

Access is throttled.

HTTP Status Code: 429

UnsupportedUserEditionException

This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

HTTP Status Code: 403