ListCustomPermissionsCommand

Returns a list of all the custom permissions profiles.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { QuickSightClient, ListCustomPermissionsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
// const { QuickSightClient, ListCustomPermissionsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
const client = new QuickSightClient(config);
const input = { // ListCustomPermissionsRequest
  AwsAccountId: "STRING_VALUE", // required
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new ListCustomPermissionsCommand(input);
const response = await client.send(command);
// { // ListCustomPermissionsResponse
//   Status: Number("int"),
//   CustomPermissionsList: [ // CustomPermissionsList
//     { // CustomPermissions
//       Arn: "STRING_VALUE",
//       CustomPermissionsName: "STRING_VALUE",
//       Capabilities: { // Capabilities
//         ExportToCsv: "DENY",
//         ExportToExcel: "DENY",
//         CreateAndUpdateThemes: "DENY",
//         AddOrRunAnomalyDetectionForAnalyses: "DENY",
//         ShareAnalyses: "DENY",
//         CreateAndUpdateDatasets: "DENY",
//         ShareDatasets: "DENY",
//         SubscribeDashboardEmailReports: "DENY",
//         CreateAndUpdateDashboardEmailReports: "DENY",
//         ShareDashboards: "DENY",
//         CreateAndUpdateThresholdAlerts: "DENY",
//         RenameSharedFolders: "DENY",
//         CreateSharedFolders: "DENY",
//         CreateAndUpdateDataSources: "DENY",
//         ShareDataSources: "DENY",
//         ViewAccountSPICECapacity: "DENY",
//         CreateSPICEDataset: "DENY",
//       },
//     },
//   ],
//   NextToken: "STRING_VALUE",
//   RequestId: "STRING_VALUE",
// };

ListCustomPermissionsCommand Input

Parameter
Type
Description
AwsAccountId
Required
string | undefined

The ID of the Amazon Web Services account that contains the custom permissions profiles that you want to list.

MaxResults
number | undefined

The maximum number of results to return.

NextToken
string | undefined

The token for the next set of results, or null if there are no more results.

ListCustomPermissionsCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
CustomPermissionsList
CustomPermissions[] | undefined

A list of custom permissions profiles.

NextToken
string | undefined

The token for the next set of results, or null if there are no more results.

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

InvalidParameterValueException
client

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

PreconditionNotMetException
client

One or more preconditions aren't met.

ResourceNotFoundException
client

One or more resources can't be found.

ResourceUnavailableException
server

This resource is currently unavailable.

ThrottlingException
client

Access is throttled.

QuickSightServiceException
Base exception class for all service exceptions from QuickSight service.