QuickSight / Client / batch_delete_knowledge_base

batch_delete_knowledge_base¶

QuickSight.Client.batch_delete_knowledge_base(**kwargs)¶

Deletes one or more knowledge bases.

Request Syntax

response = client.batch_delete_knowledge_base(
    AwsAccountId='string',
    KnowledgeBaseIds=[
        'string',
    ]
)

Parameters:

AwsAccountId (string) –
[REQUIRED]

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

A list of knowledge base identifiers to delete.
- (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Deleted': [
        {
            'KnowledgeBaseId': 'string',
            'KnowledgeBaseArn': 'string'
        },
    ],
    'Errors': [
        {
            'KnowledgeBaseId': 'string',
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ],
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) –
- Deleted (list) –
  
  A list of knowledge bases that were successfully deleted.
  - (dict) –
    
    Information about a knowledge base that was successfully deleted in a batch operation.
    - KnowledgeBaseId (string) –
      
      The unique identifier of the successfully deleted knowledge base.
    - KnowledgeBaseArn (string) –
      
      The ARN of the successfully deleted knowledge base.
- Errors (list) –
  
  A list of knowledge bases that failed to be deleted.
  - (dict) –
    
    Information about a knowledge base that failed to be deleted in a batch operation.
    - KnowledgeBaseId (string) –
      
      The unique identifier of the knowledge base that failed to be deleted.
    - ErrorCode (string) –
      
      The error code for the deletion failure.
    - ErrorMessage (string) –
      
      The error message for the deletion failure.
- 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.LimitExceededException
QuickSight.Client.exceptions.AccessDeniedException