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

SearchKnowledgeBases

Searches for a subset of knowledge bases based on specified filters.

Request Syntax


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

{
   "Filters": [ 
      { 
         "name": "string",
         "operator": "string",
         "value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string",
   "SortBy": { 
      "sortByField": "string",
      "sortOrder": "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.

Filters

The filters to apply when searching knowledge bases.

Type: Array of KnowledgeBaseSearchFilter objects

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

Required: No

MaxResults

The maximum number of results to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

The token for the next set of results, or null if there are no more results.

Type: String

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

Required: No

SortBy

The sort configuration for the search results.

Type: KnowledgeBaseSortBy object

Required: No

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "KnowledgeBaseSummaries": [ 
      { 
         "CreatedAt": number,
         "DataSourceArn": "string",
         "DocumentCount": number,
         "KnowledgeBaseArn": "string",
         "KnowledgeBaseId": "string",
         "KnowledgeBaseSizeBytes": number,
         "Name": "string",
         "PrimaryOwnerArn": "string",
         "PrimaryOwnerUsername": "string",
         "Status": "string",
         "Type": "string",
         "UpdatedAt": number
      }
   ],
   "NextToken": "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.

KnowledgeBaseSummaries

A list of knowledge base summaries.

Type: Array of KnowledgeBaseSummary objects

NextToken

The token for the next set of results, or null if there are no more results.

Type: String

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

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

InvalidNextTokenException

The NextToken value isn't valid.

RequestId: The AWS request ID for this request.

HTTP Status Code: 400

InvalidParameterValueException

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

RequestId: The AWS request ID for this request.

HTTP Status Code: 400

PreconditionNotMetException

One or more preconditions aren't met.

RequestId: The AWS request ID for this request.

HTTP Status Code: 400

ResourceNotFoundException

One or more resources can't be found.

RequestId: The AWS request ID for this request.
ResourceType: The resource type for this request.

HTTP Status Code: 404

ThrottlingException

Access is throttled.

RequestId: The AWS request ID for this request.

HTTP Status Code: 429