QuickSight / Paginator / ListCustomPermissions

ListCustomPermissions

class QuickSight.Paginator.ListCustomPermissions

paginator = client.get_paginator('list_custom_permissions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from QuickSight.Client.list_custom_permissions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AwsAccountId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• AwsAccountId (string) –

  [REQUIRED]

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'Status': 123,
    'CustomPermissionsList': [
        {
            'Arn': 'string',
            'CustomPermissionsName': 'string',
            'Capabilities': {
                'ExportToCsv': 'DENY',
                'ExportToExcel': 'DENY',
                'ExportToPdf': 'DENY',
                'PrintReports': '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',
                'ExportToPdfInScheduledReports': 'DENY',
                'ExportToCsvInScheduledReports': 'DENY',
                'ExportToExcelInScheduledReports': 'DENY',
                'IncludeContentInScheduledReportsEmail': 'DENY',
                'Dashboard': 'DENY',
                'Analysis': 'DENY',
                'Automate': 'DENY',
                'Flow': 'DENY',
                'PublishWithoutApproval': 'DENY',
                'UseBedrockModels': 'DENY',
                'PerformFlowUiTask': 'DENY',
                'UseAgentWebSearch': 'DENY',
                'KnowledgeBase': 'DENY',
                'Action': 'DENY',
                'Space': 'DENY',
                'ChatAgent': 'DENY',
                'CreateChatAgents': 'DENY',
                'Research': 'DENY'
            }
        },
    ],
    '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 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.

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

  • RequestId (string) –

    The Amazon Web Services request ID for this operation.