QuickSight / Client / describe_space_permissions

describe_space_permissions

QuickSight.Client.describe_space_permissions(**kwargs)

Describes the permissions for an Amazon QuickSight space.

See also: AWS API Documentation

Request Syntax

response = client.describe_space_permissions(
    AwsAccountId='string',
    SpaceId='string'
)
Parameters:
  • AwsAccountId (string) –

    [REQUIRED]

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

  • SpaceId (string) –

    [REQUIRED]

    The ID of the space that you want to describe permissions for.

Return type:

dict

Returns:

Response Syntax

{
    'spaceId': 'string',
    'spaceArn': 'string',
    'Permissions': [
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    'RequestId': 'string'
}

Response Structure

  • (dict) –

    • spaceId (string) –

      The ID of the space.

    • spaceArn (string) –

      The ARN of the space.

    • Permissions (list) –

      A list of resource permissions for the space.

      • (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) –

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

Exceptions

  • QuickSight.Client.exceptions.ThrottlingException

  • QuickSight.Client.exceptions.InvalidParameterValueException

  • QuickSight.Client.exceptions.InternalFailureException

  • QuickSight.Client.exceptions.ResourceNotFoundException

  • QuickSight.Client.exceptions.AccessDeniedException