Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . quicksight ]

list-custom-permissions

Description

Returns a list of all the custom permissions profiles.

See also: AWS API Documentation

list-custom-permissions is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: CustomPermissionsList

Synopsis

  list-custom-permissions
--aws-account-id <value>
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--aws-account-id (string)

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

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

Status -> (integer)

The HTTP status of the request.

CustomPermissionsList -> (list)

A list of custom permissions profiles.

(structure)

The custom permissions profile.

Arn -> (string)

The Amazon Resource Name (ARN) of the custom permissions profile.

CustomPermissionsName -> (string)

The name of the custom permissions profile.

Capabilities -> (structure)

A set of actions in the custom permissions profile.

ExportToCsv -> (string)

The ability to export to CSV files from the UI.

ExportToExcel -> (string)

The ability to export to Excel files from the UI.

ExportToPdf -> (string)

The ability to export to PDF files from the UI.

PrintReports -> (string)

The ability to print reports.

CreateAndUpdateThemes -> (string)

The ability to export to Create and Update themes.

AddOrRunAnomalyDetectionForAnalyses -> (string)

The ability to add or run anomaly detection.

ShareAnalyses -> (string)

The ability to share analyses.

CreateAndUpdateDatasets -> (string)

The ability to create and update datasets.

ShareDatasets -> (string)

The ability to share datasets.

SubscribeDashboardEmailReports -> (string)

The ability to subscribe to email reports.

CreateAndUpdateDashboardEmailReports -> (string)

The ability to create and update email reports.

ShareDashboards -> (string)

The ability to share dashboards.

CreateAndUpdateThresholdAlerts -> (string)

The ability to create and update threshold alerts.

RenameSharedFolders -> (string)

The ability to rename shared folders.

CreateSharedFolders -> (string)

The ability to create shared folders.

CreateAndUpdateDataSources -> (string)

The ability to create and update data sources.

ShareDataSources -> (string)

The ability to share data sources.

ViewAccountSPICECapacity -> (string)

The ability to view account SPICE capacity.

CreateSPICEDataset -> (string)

The ability to create a SPICE dataset.

ExportToPdfInScheduledReports -> (string)

The ability to export to PDF files in scheduled email reports.

ExportToCsvInScheduledReports -> (string)

The ability to export to CSV files in scheduled email reports.

ExportToExcelInScheduledReports -> (string)

The ability to export to Excel files in scheduled email reports.

IncludeContentInScheduledReportsEmail -> (string)

The ability to include content in scheduled email reports.

Dashboard -> (string)

The ability to perform dashboard-related actions.

Analysis -> (string)

The ability to perform analysis-related actions.

Automate -> (string)

The ability to perform automate-related actions.

Flow -> (string)

The ability to perform flow-related actions.

PublishWithoutApproval -> (string)

The ability to enable approvals for flow share.

UseBedrockModels -> (string)

The ability to use Bedrock models for general knowledge step in flows.

PerformFlowUiTask -> (string)

The ability to use UI Agent step to perform tasks on public websites.

UseAgentWebSearch -> (string)

The ability to use internet to enhance results in Chat Agents, Flows, and Quick Research. Web search queries will be processed securely in an Amazon Web Services region us-east-1 .

KnowledgeBase -> (string)

The ability to use knowledge bases to specify content from external applications.

Action -> (string)

The ability to perform actions in external services through Action connectors. Actions allow users to interact with third-party systems.

GenericHTTPAction -> (string)

The ability to perform actions using REST API connection connectors.

CreateAndUpdateGenericHTTPAction -> (string)

The ability to create and update REST API connection actions.

ShareGenericHTTPAction -> (string)

The ability to share REST API connection actions.

UseGenericHTTPAction -> (string)

The ability to use REST API connection actions.

AsanaAction -> (string)

The ability to perform actions using Asana connectors.

CreateAndUpdateAsanaAction -> (string)

The ability to create and update Asana actions.

ShareAsanaAction -> (string)

The ability to share Asana actions.

UseAsanaAction -> (string)

The ability to use Asana actions.

SlackAction -> (string)

The ability to perform actions using Slack connectors.

CreateAndUpdateSlackAction -> (string)

The ability to create and update Slack actions.

ShareSlackAction -> (string)

The ability to share Slack actions.

UseSlackAction -> (string)

The ability to use Slack actions.

ServiceNowAction -> (string)

The ability to perform actions using ServiceNow connectors.

CreateAndUpdateServiceNowAction -> (string)

The ability to create and update ServiceNow actions.

ShareServiceNowAction -> (string)

The ability to share ServiceNow actions.

UseServiceNowAction -> (string)

The ability to use ServiceNow actions.

SalesforceAction -> (string)

The ability to perform actions using Salesforce connectors.

CreateAndUpdateSalesforceAction -> (string)

The ability to create and update Salesforce actions.

ShareSalesforceAction -> (string)

The ability to share Salesforce actions.

UseSalesforceAction -> (string)

The ability to use Salesforce actions.

MSExchangeAction -> (string)

The ability to perform actions using Microsoft Outlook connectors.

CreateAndUpdateMSExchangeAction -> (string)

The ability to create and update Microsoft Outlook actions.

ShareMSExchangeAction -> (string)

The ability to share Microsoft Outlook actions.

UseMSExchangeAction -> (string)

The ability to use Microsoft Outlook actions.

PagerDutyAction -> (string)

The ability to perform actions using PagerDuty Advance connectors.

CreateAndUpdatePagerDutyAction -> (string)

The ability to create and update PagerDuty Advance actions.

SharePagerDutyAction -> (string)

The ability to share PagerDuty Advance actions.

UsePagerDutyAction -> (string)

The ability to use PagerDuty Advance actions.

JiraAction -> (string)

The ability to perform actions using Jira connectors.

CreateAndUpdateJiraAction -> (string)

The ability to create and update Jira actions.

ShareJiraAction -> (string)

The ability to share Jira actions.

UseJiraAction -> (string)

The ability to use Jira actions.

ConfluenceAction -> (string)

The ability to perform actions using Atlassian Confluence Cloud connectors.

CreateAndUpdateConfluenceAction -> (string)

The ability to create and update Atlassian Confluence Cloud actions.

ShareConfluenceAction -> (string)

The ability to share Atlassian Confluence Cloud actions.

UseConfluenceAction -> (string)

The ability to use Atlassian Confluence Cloud actions.

OneDriveAction -> (string)

The ability to perform actions using Microsoft OneDrive connectors.

CreateAndUpdateOneDriveAction -> (string)

The ability to create and update Microsoft OneDrive actions.

ShareOneDriveAction -> (string)

The ability to share Microsoft OneDrive actions.

UseOneDriveAction -> (string)

The ability to use Microsoft OneDrive actions.

SharePointAction -> (string)

The ability to perform actions using Microsoft SharePoint Online connectors.

CreateAndUpdateSharePointAction -> (string)

The ability to create and update Microsoft SharePoint Online actions.

ShareSharePointAction -> (string)

The ability to share Microsoft SharePoint Online actions.

UseSharePointAction -> (string)

The ability to use Microsoft SharePoint Online actions.

MSTeamsAction -> (string)

The ability to perform actions using Microsoft Teams connectors.

CreateAndUpdateMSTeamsAction -> (string)

The ability to create and update Microsoft Teams actions.

ShareMSTeamsAction -> (string)

The ability to share Microsoft Teams actions.

UseMSTeamsAction -> (string)

The ability to use Microsoft Teams actions.

GoogleCalendarAction -> (string)

The ability to perform actions using Google Calendar connectors.

CreateAndUpdateGoogleCalendarAction -> (string)

The ability to create and update Google Calendar actions.

ShareGoogleCalendarAction -> (string)

The ability to share Google Calendar actions.

UseGoogleCalendarAction -> (string)

The ability to use Google Calendar actions.

ZendeskAction -> (string)

The ability to perform actions using Zendesk connectors.

CreateAndUpdateZendeskAction -> (string)

The ability to create and update Zendesk actions.

ShareZendeskAction -> (string)

The ability to share Zendesk actions.

UseZendeskAction -> (string)

The ability to use Zendesk actions.

SmartsheetAction -> (string)

The ability to perform actions using Smartsheet connectors.

CreateAndUpdateSmartsheetAction -> (string)

The ability to create and update Smartsheet actions.

ShareSmartsheetAction -> (string)

The ability to share Smartsheet actions.

UseSmartsheetAction -> (string)

The ability to use Smartsheet actions.

SAPBusinessPartnerAction -> (string)

The ability to perform actions using SAP Business Partner connectors.

CreateAndUpdateSAPBusinessPartnerAction -> (string)

The ability to create and update SAP Business Partner actions.

ShareSAPBusinessPartnerAction -> (string)

The ability to share SAP Business Partner actions.

UseSAPBusinessPartnerAction -> (string)

The ability to use SAP Business Partner actions.

SAPProductMasterDataAction -> (string)

The ability to perform actions using SAP Product Master connectors.

CreateAndUpdateSAPProductMasterDataAction -> (string)

The ability to create and update SAP Product Master actions.

ShareSAPProductMasterDataAction -> (string)

The ability to share SAP Product Master actions.

UseSAPProductMasterDataAction -> (string)

The ability to use SAP Product Master actions.

SAPPhysicalInventoryAction -> (string)

The ability to perform actions using SAP Physical Inventory connectors.

CreateAndUpdateSAPPhysicalInventoryAction -> (string)

The ability to create and update SAP Physical Inventory actions.

ShareSAPPhysicalInventoryAction -> (string)

The ability to share SAP Physical Inventory actions.

UseSAPPhysicalInventoryAction -> (string)

The ability to use SAP Physical Inventory actions.

SAPBillOfMaterialAction -> (string)

The ability to perform actions using SAP Bill of Materials connectors.

CreateAndUpdateSAPBillOfMaterialAction -> (string)

The ability to create and update SAP Bill of Materials actions.

ShareSAPBillOfMaterialAction -> (string)

The ability to share SAP Bill of Materials actions.

UseSAPBillOfMaterialAction -> (string)

The ability to use SAP Bill of Materials actions.

SAPMaterialStockAction -> (string)

The ability to perform actions using SAP Material Stock connectors.

CreateAndUpdateSAPMaterialStockAction -> (string)

The ability to create and update SAP Material Stock actions.

ShareSAPMaterialStockAction -> (string)

The ability to share SAP Material Stock actions.

UseSAPMaterialStockAction -> (string)

The ability to use SAP Material Stock actions.

FactSetAction -> (string)

The ability to perform actions using FactSet connectors.

CreateAndUpdateFactSetAction -> (string)

The ability to create and update FactSet actions.

ShareFactSetAction -> (string)

The ability to share FactSet actions.

UseFactSetAction -> (string)

The ability to use FactSet actions.

AmazonSThreeAction -> (string)

The ability to perform actions using Amazon S3 connectors.

CreateAndUpdateAmazonSThreeAction -> (string)

The ability to create and update Amazon S3 actions.

ShareAmazonSThreeAction -> (string)

The ability to share Amazon S3 actions.

UseAmazonSThreeAction -> (string)

The ability to use Amazon S3 actions.

TextractAction -> (string)

The ability to perform actions using Textract connectors.

CreateAndUpdateTextractAction -> (string)

The ability to create and update Textract actions.

ShareTextractAction -> (string)

The ability to share Textract actions.

UseTextractAction -> (string)

The ability to use Textract actions.

ComprehendAction -> (string)

The ability to perform actions using Comprehend connectors.

CreateAndUpdateComprehendAction -> (string)

The ability to create and update Comprehend actions.

ShareComprehendAction -> (string)

The ability to share Comprehend actions.

UseComprehendAction -> (string)

The ability to use Comprehend actions.

ComprehendMedicalAction -> (string)

The ability to perform actions using Comprehend Medical connectors.

CreateAndUpdateComprehendMedicalAction -> (string)

The ability to create and update Comprehend Medical actions.

ShareComprehendMedicalAction -> (string)

The ability to share Comprehend Medical actions.

UseComprehendMedicalAction -> (string)

The ability to use Comprehend Medical actions.

AmazonBedrockARSAction -> (string)

The ability to perform actions using Bedrock Agent connectors.

CreateAndUpdateAmazonBedrockARSAction -> (string)

The ability to create and update Bedrock Agent actions.

ShareAmazonBedrockARSAction -> (string)

The ability to share Bedrock Agent actions.

UseAmazonBedrockARSAction -> (string)

The ability to use Bedrock Agent actions.

AmazonBedrockFSAction -> (string)

The ability to perform actions using Bedrock Runtime connectors.

CreateAndUpdateAmazonBedrockFSAction -> (string)

The ability to create and update Bedrock Runtime actions.

ShareAmazonBedrockFSAction -> (string)

The ability to share Bedrock Runtime actions.

UseAmazonBedrockFSAction -> (string)

The ability to use Bedrock Runtime actions.

AmazonBedrockKRSAction -> (string)

The ability to perform actions using Bedrock Data Automation Runtime connectors.

CreateAndUpdateAmazonBedrockKRSAction -> (string)

The ability to create and update Bedrock Data Automation Runtime actions.

ShareAmazonBedrockKRSAction -> (string)

The ability to share Bedrock Data Automation Runtime actions.

UseAmazonBedrockKRSAction -> (string)

The ability to use Bedrock Data Automation Runtime actions.

MCPAction -> (string)

The ability to perform actions using Model Context Protocol connectors.

CreateAndUpdateMCPAction -> (string)

The ability to create and update Model Context Protocol actions.

ShareMCPAction -> (string)

The ability to share Model Context Protocol actions.

UseMCPAction -> (string)

The ability to use Model Context Protocol actions.

OpenAPIAction -> (string)

The ability to perform actions using OpenAPI Specification connectors.

CreateAndUpdateOpenAPIAction -> (string)

The ability to create and update OpenAPI Specification actions.

ShareOpenAPIAction -> (string)

The ability to share OpenAPI Specification actions.

UseOpenAPIAction -> (string)

The ability to use OpenAPI Specification actions.

SandPGMIAction -> (string)

The ability to perform actions using S&P Global Market Intelligence connectors.

CreateAndUpdateSandPGMIAction -> (string)

The ability to create and update S&P Global Market Intelligence actions.

ShareSandPGMIAction -> (string)

The ability to share S&P Global Market Intelligence actions.

UseSandPGMIAction -> (string)

The ability to use S&P Global Market Intelligence actions.

SandPGlobalEnergyAction -> (string)

The ability to perform actions using S&P Global Energy connectors.

CreateAndUpdateSandPGlobalEnergyAction -> (string)

The ability to create and update S&P Global Energy actions.

ShareSandPGlobalEnergyAction -> (string)

The ability to share S&P Global Energy actions.

UseSandPGlobalEnergyAction -> (string)

The ability to use S&P Global Energy actions.

BambooHRAction -> (string)

The ability to perform actions using BambooHR connectors.

CreateAndUpdateBambooHRAction -> (string)

The ability to create and update BambooHR actions.

ShareBambooHRAction -> (string)

The ability to share BambooHR actions.

UseBambooHRAction -> (string)

The ability to use BambooHR actions.

BoxAgentAction -> (string)

The ability to perform actions using Box Agent connectors.

CreateAndUpdateBoxAgentAction -> (string)

The ability to create and update Box Agent actions.

ShareBoxAgentAction -> (string)

The ability to share Box Agent actions.

UseBoxAgentAction -> (string)

The ability to use Box Agent actions.

CanvaAgentAction -> (string)

The ability to perform actions using Canva Agent connectors.

CreateAndUpdateCanvaAgentAction -> (string)

The ability to create and update Canva Agent actions.

ShareCanvaAgentAction -> (string)

The ability to share Canva Agent actions.

UseCanvaAgentAction -> (string)

The ability to use Canva Agent actions.

GithubAction -> (string)

The ability to perform actions using GitHub connectors.

CreateAndUpdateGithubAction -> (string)

The ability to create and update GitHub actions.

ShareGithubAction -> (string)

The ability to share GitHub actions.

UseGithubAction -> (string)

The ability to use GitHub actions.

NotionAction -> (string)

The ability to perform actions using Notion connectors.

CreateAndUpdateNotionAction -> (string)

The ability to create and update Notion actions.

ShareNotionAction -> (string)

The ability to share Notion actions.

UseNotionAction -> (string)

The ability to use Notion actions.

LinearAction -> (string)

The ability to perform actions using Linear connectors.

CreateAndUpdateLinearAction -> (string)

The ability to create and update Linear actions.

ShareLinearAction -> (string)

The ability to share Linear actions.

UseLinearAction -> (string)

The ability to use Linear actions.

HuggingFaceAction -> (string)

The ability to perform actions using HuggingFace connectors.

CreateAndUpdateHuggingFaceAction -> (string)

The ability to create and update HuggingFace actions.

ShareHuggingFaceAction -> (string)

The ability to share HuggingFace actions.

UseHuggingFaceAction -> (string)

The ability to use HuggingFace actions.

MondayAction -> (string)

The ability to perform actions using Monday connectors.

CreateAndUpdateMondayAction -> (string)

The ability to create and update Monday actions.

ShareMondayAction -> (string)

The ability to share Monday actions.

UseMondayAction -> (string)

The ability to use Monday actions.

HubspotAction -> (string)

The ability to perform actions using Hubspot connectors.

CreateAndUpdateHubspotAction -> (string)

The ability to create and update Hubspot actions.

ShareHubspotAction -> (string)

The ability to share Hubspot actions.

UseHubspotAction -> (string)

The ability to use Hubspot actions.

IntercomAction -> (string)

The ability to perform actions using Intercom connectors.

CreateAndUpdateIntercomAction -> (string)

The ability to create and update Intercom actions.

ShareIntercomAction -> (string)

The ability to share Intercom actions.

UseIntercomAction -> (string)

The ability to use Intercom actions.

NewRelicAction -> (string)

The ability to perform actions using New Relic connectors.

CreateAndUpdateNewRelicAction -> (string)

The ability to create and update New Relic actions.

ShareNewRelicAction -> (string)

The ability to share New Relic actions.

UseNewRelicAction -> (string)

The ability to use New Relic actions.

Space -> (string)

The ability to perform space-related actions.

ChatAgent -> (string)

The ability to perform chat-related actions.

CreateChatAgents -> (string)

The ability to create chat agents.

Research -> (string)

The ability to perform research-related actions.

SelfUpgradeUserRole -> (string)

The ability to enable users to upgrade their user role.

NextToken -> (string)

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

RequestId -> (string)

The Amazon Web Services request ID for this operation.