QuickSight / Client / create_custom_permissions

create_custom_permissions#

QuickSight.Client.create_custom_permissions(**kwargs)#

Creates a custom permissions profile.

See also: AWS API Documentation

Request Syntax

response = client.create_custom_permissions(
    AwsAccountId='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'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:
  • AwsAccountId (string) –

    [REQUIRED]

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

  • CustomPermissionsName (string) –

    [REQUIRED]

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

  • Capabilities (dict) –

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

  • Tags (list) –

    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.

Return type:

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.

Exceptions

  • QuickSight.Client.exceptions.ConflictException

  • QuickSight.Client.exceptions.AccessDeniedException

  • QuickSight.Client.exceptions.ResourceNotFoundException

  • QuickSight.Client.exceptions.ResourceExistsException

  • QuickSight.Client.exceptions.InvalidParameterValueException

  • QuickSight.Client.exceptions.ThrottlingException

  • QuickSight.Client.exceptions.PreconditionNotMetException

  • QuickSight.Client.exceptions.LimitExceededException

  • QuickSight.Client.exceptions.InternalFailureException

  • QuickSight.Client.exceptions.ResourceUnavailableException