QuickSight / Client / update_space_permissions

update_space_permissions¶

QuickSight.Client.update_space_permissions(**kwargs)¶

Updates the permissions for an Amazon QuickSight space.

Request Syntax

response = client.update_space_permissions(
    AwsAccountId='string',
    SpaceId='string',
    GrantPermissions=[
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    RevokePermissions=[
        {
            'Principal': 'string',
            'Actions': [
                '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 update permissions for.
GrantPermissions (list) –
The permissions that you want to grant on the space.
- (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 space.
- (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) –

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) –
  
  The updated 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.LimitExceededException
QuickSight.Client.exceptions.UnsupportedUserEditionException
QuickSight.Client.exceptions.AccessDeniedException
QuickSight.Client.exceptions.ConflictException