Amazon QuickSight

2025/12/29 - Amazon QuickSight - 4 new4 updated api methods

Changes  This release adds support for quick users to be able to perform role upgrades on their own. Additionally it allows admins to make this feature admin or auto approval along with new self upgrade capability that can be restricted by Admins.

UpdateSelfUpgrade (new) Link ¶

Updates a self-upgrade request for a Quick Suite user by approving, denying, or verifying the request.

See also: AWS API Documentation

Request Syntax

client.update_self_upgrade(
    AwsAccountId='string',
    Namespace='string',
    UpgradeRequestId='string',
    Action='APPROVE'|'DENY'|'VERIFY'
)
type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the self-upgrade request.

type Namespace:

string

param Namespace:

[REQUIRED]

The Quick Suite namespace for the self-upgrade request.

type UpgradeRequestId:

string

param UpgradeRequestId:

[REQUIRED]

The ID of the self-upgrade request to update.

type Action:

string

param Action:

[REQUIRED]

The action to perform on the self-upgrade request. Valid values are APPROVE, DENY, or VERIFY.

rtype:

dict

returns:

Response Syntax

{
    'SelfUpgradeRequestDetail': {
        'UpgradeRequestId': 'string',
        'UserName': 'string',
        'OriginalRole': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO',
        'RequestedRole': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO',
        'RequestNote': 'string',
        'CreationTime': 123,
        'RequestStatus': 'PENDING'|'APPROVED'|'DENIED'|'UPDATE_FAILED'|'VERIFY_FAILED',
        'lastUpdateAttemptTime': 123,
        'lastUpdateFailureReason': 'string'
    },
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) --

    • SelfUpgradeRequestDetail (dict) --

      Details of the updated self-upgrade request.

      • UpgradeRequestId (string) --

        The ID of the self-upgrade request.

      • UserName (string) --

        The username of the user who initiated the self-upgrade request.

      • OriginalRole (string) --

        The original role of the user before the upgrade.

      • RequestedRole (string) --

        The role that the user is requesting to upgrade to.

      • RequestNote (string) --

        An optional note explaining the reason for the self-upgrade request.

      • CreationTime (integer) --

        The time when the self-upgrade request was created.

      • RequestStatus (string) --

        The status of the self-upgrade request.

      • lastUpdateAttemptTime (integer) --

        The time of the last update attempt for the self-upgrade request.

      • lastUpdateFailureReason (string) --

        The reason for the last update failure, if applicable.

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

    • Status (integer) --

      The HTTP status of the request.

ListSelfUpgrades (new) Link ¶

Lists all self-upgrade requests for a Quick Suite account.

See also: AWS API Documentation

Request Syntax

client.list_self_upgrades(
    AwsAccountId='string',
    Namespace='string',
    NextToken='string',
    MaxResults=123
)
type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the self-upgrade requests.

type Namespace:

string

param Namespace:

[REQUIRED]

The Quick Suite namespace for the self-upgrade requests.

type NextToken:

string

param NextToken:

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

type MaxResults:

integer

param MaxResults:

The maximum number of results to return.

rtype:

dict

returns:

Response Syntax

{
    'SelfUpgradeRequestDetails': [
        {
            'UpgradeRequestId': 'string',
            'UserName': 'string',
            'OriginalRole': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO',
            'RequestedRole': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO',
            'RequestNote': 'string',
            'CreationTime': 123,
            'RequestStatus': 'PENDING'|'APPROVED'|'DENIED'|'UPDATE_FAILED'|'VERIFY_FAILED',
            'lastUpdateAttemptTime': 123,
            'lastUpdateFailureReason': 'string'
        },
    ],
    'NextToken': 'string',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) --

    • SelfUpgradeRequestDetails (list) --

      A list of self-upgrade request details.

      • (dict) --

        Details of a self-upgrade request.

        • UpgradeRequestId (string) --

          The ID of the self-upgrade request.

        • UserName (string) --

          The username of the user who initiated the self-upgrade request.

        • OriginalRole (string) --

          The original role of the user before the upgrade.

        • RequestedRole (string) --

          The role that the user is requesting to upgrade to.

        • RequestNote (string) --

          An optional note explaining the reason for the self-upgrade request.

        • CreationTime (integer) --

          The time when the self-upgrade request was created.

        • RequestStatus (string) --

          The status of the self-upgrade request.

        • lastUpdateAttemptTime (integer) --

          The time of the last update attempt for the self-upgrade request.

        • lastUpdateFailureReason (string) --

          The reason for the last update failure, if applicable.

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

    • Status (integer) --

      The HTTP status of the request.

DescribeSelfUpgradeConfiguration (new) Link ¶

Describes the self-upgrade configuration for a Quick Suite account.

See also: AWS API Documentation

Request Syntax

client.describe_self_upgrade_configuration(
    AwsAccountId='string',
    Namespace='string'
)
type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the Quick Suite self-upgrade configuration.

type Namespace:

string

param Namespace:

[REQUIRED]

The Quick Suite namespace that you want to describe the Quick Suite self-upgrade configuration for.

rtype:

dict

returns:

Response Syntax

{
    'SelfUpgradeConfiguration': {
        'SelfUpgradeStatus': 'AUTO_APPROVAL'|'ADMIN_APPROVAL'
    },
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) --

    • SelfUpgradeConfiguration (dict) --

      The self-upgrade configuration for the Quick Suite account.

      • SelfUpgradeStatus (string) --

        Status set for the self-upgrade configuration for the Quick Suite account. It can contain the following values:

        • AUTO_APPROVAL: All the self-upgrade requests will be auto approved.

        • ADMIN_APPROVAL: All the self-upgrade requests will require admin approval.

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

    • Status (integer) --

      The HTTP status of the request.

UpdateSelfUpgradeConfiguration (new) Link ¶

Updates the self-upgrade configuration for a Quick Suite account.

See also: AWS API Documentation

Request Syntax

client.update_self_upgrade_configuration(
    AwsAccountId='string',
    Namespace='string',
    SelfUpgradeStatus='AUTO_APPROVAL'|'ADMIN_APPROVAL'
)
type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the Quick Suite self-upgrade configuration that you want to update.

type Namespace:

string

param Namespace:

[REQUIRED]

The Quick Suite namespace that you want to update the Quick Suite self-upgrade configuration for.

type SelfUpgradeStatus:

string

param SelfUpgradeStatus:

[REQUIRED]

The self-upgrade status that you want to set for the Quick Suite account.

rtype:

dict

returns:

Response Syntax

{
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) --

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

    • Status (integer) --

      The HTTP status of the request.

CreateCustomPermissions (updated) Link ¶
Changes (request)
{'Capabilities': {'SelfUpgradeUserRole': 'DENY'}}

Creates a custom permissions profile.

See also: AWS API Documentation

Request Syntax

client.create_custom_permissions(
    AwsAccountId='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',
        'SelfUpgradeUserRole': 'DENY'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that you want to create the custom permissions profile in.

type CustomPermissionsName:

string

param CustomPermissionsName:

[REQUIRED]

The name of the custom permissions profile that you want to create.

type Capabilities:

dict

param Capabilities:

A set of actions to include 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.

  • SelfUpgradeUserRole (string) --

    The ability to enable users to upgrade their user role.

type Tags:

list

param Tags:

The tags to associate with the custom permissions profile.

  • (dict) --

    The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.

    • Key (string) -- [REQUIRED]

      Tag key.

    • Value (string) -- [REQUIRED]

      Tag value.

rtype:

dict

returns:

Response Syntax

{
    'Status': 123,
    'Arn': 'string',
    'RequestId': 'string'
}

Response Structure

  • (dict) --

    • Status (integer) --

      The HTTP status of the request.

    • Arn (string) --

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

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

DescribeCustomPermissions (updated) Link ¶
Changes (response)
{'CustomPermissions': {'Capabilities': {'SelfUpgradeUserRole': 'DENY'}}}

Describes a custom permissions profile.

See also: AWS API Documentation

Request Syntax

client.describe_custom_permissions(
    AwsAccountId='string',
    CustomPermissionsName='string'
)
type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the custom permissions profile that you want described.

type CustomPermissionsName:

string

param CustomPermissionsName:

[REQUIRED]

The name of the custom permissions profile to describe.

rtype:

dict

returns:

Response Syntax

{
    'Status': 123,
    'CustomPermissions': {
        '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',
            'SelfUpgradeUserRole': 'DENY'
        }
    },
    'RequestId': 'string'
}

Response Structure

  • (dict) --

    • Status (integer) --

      The HTTP status of the request.

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

        • SelfUpgradeUserRole (string) --

          The ability to enable users to upgrade their user role.

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

ListCustomPermissions (updated) Link ¶
Changes (response)
{'CustomPermissionsList': {'Capabilities': {'SelfUpgradeUserRole': 'DENY'}}}

Returns a list of all the custom permissions profiles.

See also: AWS API Documentation

Request Syntax

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

string

param AwsAccountId:

[REQUIRED]

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

type MaxResults:

integer

param MaxResults:

The maximum number of results to return.

type NextToken:

string

param NextToken:

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

rtype:

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',
                'SelfUpgradeUserRole': '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 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.

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

UpdateCustomPermissions (updated) Link ¶
Changes (request)
{'Capabilities': {'SelfUpgradeUserRole': 'DENY'}}

Updates a custom permissions profile.

See also: AWS API Documentation

Request Syntax

client.update_custom_permissions(
    AwsAccountId='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',
        'SelfUpgradeUserRole': 'DENY'
    }
)
type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

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

type CustomPermissionsName:

string

param CustomPermissionsName:

[REQUIRED]

The name of the custom permissions profile that you want to update.

type Capabilities:

dict

param Capabilities:

A set of actions to include 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.

  • SelfUpgradeUserRole (string) --

    The ability to enable users to upgrade their user role.

rtype:

dict

returns:

Response Syntax

{
    'Status': 123,
    'Arn': 'string',
    'RequestId': 'string'
}

Response Structure

  • (dict) --

    • Status (integer) --

      The HTTP status of the request.

    • Arn (string) --

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

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.