QuickSight / Client / describe_knowledge_base_permissions

describe_knowledge_base_permissions¶

QuickSight.Client.describe_knowledge_base_permissions(**kwargs)¶

Describes the resource permissions for a knowledge base.

Request Syntax

response = client.describe_knowledge_base_permissions(
    AwsAccountId='string',
    KnowledgeBaseId='string'
)

Parameters:

AwsAccountId (string) –
[REQUIRED]

The ID of the Amazon Web Services account that contains the knowledge base.
KnowledgeBaseId (string) –
[REQUIRED]

The unique identifier for the knowledge base.

Return type:

dict

Returns:

Response Syntax

{
    'KnowledgeBaseArn': 'string',
    'KnowledgeBaseId': 'string',
    'Permissions': [
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) –
- KnowledgeBaseArn (string) –
  
  The Amazon Resource Name (ARN) of the knowledge base.
- KnowledgeBaseId (string) –
  
  The unique identifier for the knowledge base.
- Permissions (list) –
  
  The resource permissions for the knowledge base.
  - (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.
- Status (integer) –
  
  The HTTP status of the request.

Exceptions

QuickSight.Client.exceptions.ThrottlingException
QuickSight.Client.exceptions.InvalidRequestException
QuickSight.Client.exceptions.InvalidParameterValueException
QuickSight.Client.exceptions.InternalFailureException
QuickSight.Client.exceptions.PreconditionNotMetException
QuickSight.Client.exceptions.ResourceNotFoundException
QuickSight.Client.exceptions.LimitExceededException
QuickSight.Client.exceptions.AccessDeniedException