CreateFolderMembership -

CreateFolderMembership

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

Request Syntax

PUT /accounts/AwsAccountId/folders/FolderId/members/MemberType/MemberId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The ID for the AWS account that contains 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

MemberId

The ID of the asset (the dashboard, analysis, or dataset).

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

Pattern: [\w\-]+

Required: Yes

MemberType

The type of the member, including DASHBOARD, ANALYSIS, and DATASET.

Valid Values: DASHBOARD | ANALYSIS | DATASET

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "FolderMember": { "MemberId": "string", "MemberType": "string" }, "RequestId": "string", "Status": number }

Response Elements

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

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

FolderMember

Information about the member in the folder.

Type: FolderMember object

RequestId

The AWS request ID for this operation.

Type: String

Status

The HTTP status of the request.

Type: Integer

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 access keys.

HTTP Status Code: 401

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: