QuickSight / Client / list_custom_permissions

list_custom_permissions#

QuickSight.Client.list_custom_permissions(**kwargs)#

Returns a list of all the custom permissions profiles.

Request Syntax

response = client.list_custom_permissions(
    AwsAccountId='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

AwsAccountId (string) –
[REQUIRED]

The ID of the Amazon Web Services account that contains the custom permissions profiles that you want to list.
MaxResults (integer) – The maximum number of results to return.
NextToken (string) – The token for the next set of results, or null if there are no more results.

Return type:

dict

Returns:

Response Syntax

{
    'Status': 123,
    'CustomPermissionsList': [
        {
            'Arn': 'string',
            'CustomPermissionsName': 'string',
            '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',
    'RequestId': 'string'
}

Response Structure

(dict) –
- Status (integer) –
  
  The HTTP status of the request.
- CustomPermissionsList (list) –
  
  A list of custom permissions profiles.
  - (dict) –
    
    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 (dict) –
      
      A set of actions in the custom permissions profile.
      - ExportToCsv (string) –
        
        The ability to export to CSV files.
      - ExportToExcel (string) –
        
        The ability to export to Excel files.
      - 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.
- 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.

Exceptions

QuickSight.Client.exceptions.AccessDeniedException
QuickSight.Client.exceptions.ResourceNotFoundException
QuickSight.Client.exceptions.InvalidParameterValueException
QuickSight.Client.exceptions.ThrottlingException
QuickSight.Client.exceptions.PreconditionNotMetException
QuickSight.Client.exceptions.InternalFailureException
QuickSight.Client.exceptions.ResourceUnavailableException