- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeFolderPermissionsCommand
Describes permissions for a folder.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { QuickSightClient, DescribeFolderPermissionsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
// const { QuickSightClient, DescribeFolderPermissionsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
const client = new QuickSightClient(config);
const input = { // DescribeFolderPermissionsRequest
AwsAccountId: "STRING_VALUE", // required
FolderId: "STRING_VALUE", // required
Namespace: "STRING_VALUE",
MaxResults: Number("int"),
NextToken: "STRING_VALUE",
};
const command = new DescribeFolderPermissionsCommand(input);
const response = await client.send(command);
// { // DescribeFolderPermissionsResponse
// Status: Number("int"),
// FolderId: "STRING_VALUE",
// Arn: "STRING_VALUE",
// Permissions: [ // ResourcePermissionList
// { // ResourcePermission
// Principal: "STRING_VALUE", // required
// Actions: [ // ActionList // required
// "STRING_VALUE",
// ],
// },
// ],
// RequestId: "STRING_VALUE",
// NextToken: "STRING_VALUE",
// };
DescribeFolderPermissionsCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
AwsAccountId Required | string | undefined | The ID for the Amazon Web Services account that contains the folder. |
FolderId Required | string | undefined | The ID of the folder. |
MaxResults | number | undefined | The maximum number of results to be returned per request. |
Namespace | string | undefined | The namespace of the folder whose permissions you want described. |
NextToken | string | undefined | A pagination token for the next set of results. |
DescribeFolderPermissionsCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Arn | string | undefined | The Amazon Resource Name (ARN) for the folder. |
FolderId | string | undefined | The ID of the folder. |
NextToken | string | undefined | The pagination token for the next set of results, or null if there are no more results. |
Permissions | ResourcePermission[] | undefined | Information about the permissions on the folder. |
RequestId | string | undefined | The Amazon Web Services request ID for this operation. |
Status | number | undefined | The HTTP status of the request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | 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. |
InternalFailureException | server | An internal failure occurred. |
InvalidNextTokenException | client | The |
InvalidParameterValueException | client | One or more parameters has a value that isn't valid. |
ResourceNotFoundException | client | One or more resources can't be found. |
ThrottlingException | client | Access is throttled. |
UnsupportedUserEditionException | client | 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. |
QuickSightServiceException | Base exception class for all service exceptions from QuickSight service. |