QuickSight / Client / update_app_permissions

update_app_permissions

QuickSight.Client.update_app_permissions(**kwargs)

Updates the resource permissions for an app. You can grant or revoke permissions and, optionally, change the app’s visibility.

See also: AWS API Documentation

Request Syntax

response = client.update_app_permissions(
    AwsAccountId='string',
    AppId='string',
    GrantPermissions=[
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    RevokePermissions=[
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    Visibility='PRIVATE'|'PUBLIC'
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The ID of the Amazon Web Services account that contains the app.

  • AppId (string) –

    [REQUIRED]

    The ID of the app.

  • GrantPermissions (list) –

    The permissions that you want to grant on the app.

    • (dict) –

      Permission for the resource.

      • Principal (string) – [REQUIRED]

        The Amazon Resource Name (ARN) of the principal. This can be one of the following:

        • The ARN of an Quick Sight user or group associated with a data source or dataset. (This is common.)

        • The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)

        • The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)

      • Actions (list) – [REQUIRED]

        The IAM action to grant or revoke permissions on.

        • (string) –

  • RevokePermissions (list) –

    The permissions that you want to revoke from the app.

    • (dict) –

      Permission for the resource.

      • Principal (string) – [REQUIRED]

        The Amazon Resource Name (ARN) of the principal. This can be one of the following:

        • The ARN of an Quick Sight user or group associated with a data source or dataset. (This is common.)

        • The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)

        • The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)

      • Actions (list) – [REQUIRED]

        The IAM action to grant or revoke permissions on.

        • (string) –

  • Visibility (string) – The visibility to set for the app. Currently, only PRIVATE is accepted, which removes public (anonymous) access from the app. If you don’t specify a value, the app’s visibility is unchanged. Setting an app to PUBLIC through this operation is not supported.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'AppId': 'string',
    'Permissions': [
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    'Visibility': 'PRIVATE'|'PUBLIC',
    'RequestId': 'string'
}

Response Structure

  • (dict) –

    • Arn (string) –

      The Amazon Resource Name (ARN) of the app.

    • AppId (string) –

      The ID of the app.

    • Permissions (list) –

      The updated resource permissions for the app.

      • (dict) –

        Permission for the resource.

        • Principal (string) –

          The Amazon Resource Name (ARN) of the principal. This can be one of the following:

          • The ARN of an Quick Sight user or group associated with a data source or dataset. (This is common.)

          • The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)

          • The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)

        • Actions (list) –

          The IAM action to grant or revoke permissions on.

          • (string) –

    • Visibility (string) –

      The visibility of the app after the update ( PRIVATE or PUBLIC).

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

Exceptions