Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

BatchDeleteKnowledgeBase

Deletes one or more knowledge bases.

Request Syntax


POST /v1/accounts/AwsAccountId/knowledge-bases/batch-delete HTTP/1.1
Content-type: application/json

{
   "KnowledgeBaseIds": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The ID of the AWS account that contains the knowledge base.

Length Constraints: Fixed length of 12.

Pattern: [0-9]*

Required: Yes

Request Body

The request accepts the following data in JSON format.

KnowledgeBaseIds

A list of knowledge base identifiers to delete.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [0-9a-zA-Z-_=.+]+

Required: Yes

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "Deleted": [ 
      { 
         "KnowledgeBaseArn": "string",
         "KnowledgeBaseId": "string"
      }
   ],
   "Errors": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "string",
         "KnowledgeBaseId": "string"
      }
   ],
   "RequestId": "string"
}

Response Elements

If the action is successful, the service sends back the following HTTP response.

Status: The HTTP status of the request.

The following data is returned in JSON format by the service.

Deleted

A list of knowledge bases that were successfully deleted.

Type: Array of BatchDeleteKnowledgeBaseSuccess objects

Errors

A list of knowledge bases that failed to be deleted.

Type: Array of BatchDeleteKnowledgeBaseFailure objects

RequestId

The AWS request ID for this operation.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.

RequestId: The AWS request ID for this request.

HTTP Status Code: 401

InternalFailureException

An internal failure occurred.

RequestId: The AWS request ID for this request.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameters has a value that isn't valid.

RequestId: The AWS request ID for this request.

HTTP Status Code: 400

InvalidRequestException

You don't have this feature activated for your account. To fix this issue, contact AWS support.

RequestId: The AWS request ID for this request.

HTTP Status Code: 400

LimitExceededException

A limit is exceeded.

RequestId: The AWS request ID for this request.
ResourceType: Limit exceeded.

HTTP Status Code: 409

PreconditionNotMetException

One or more preconditions aren't met.

RequestId: The AWS request ID for this request.

HTTP Status Code: 400

ThrottlingException

Access is throttled.

RequestId: The AWS request ID for this request.

HTTP Status Code: 429