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

Description¶

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

Usage¶

quicksight_search_knowledge_bases(AwsAccountId, NextToken, MaxResults,
  Filters, SortBy)

Arguments¶

AwsAccountId

[required] The ID of the Amazon Web Services account that contains the knowledge base.

NextToken

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

MaxResults

The maximum number of results to return.

Filters

The filters to apply when searching knowledge bases.

SortBy

The sort configuration for the search results.

Value¶

A list with the following syntax:

list(
  KnowledgeBaseSummaries = list(
    list(
      KnowledgeBaseArn = "string",
      KnowledgeBaseId = "string",
      Name = "string",
      Status = "CREATING"|"UPDATING"|"ACTIVE"|"FAILED"|"DELETING",
      DataSourceArn = "string",
      Type = "string",
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      UpdatedAt = as.POSIXct(
        "2015-01-01"
      ),
      KnowledgeBaseSizeBytes = 123,
      DocumentCount = 123,
      PrimaryOwnerArn = "string",
      PrimaryOwnerUsername = "string"
    )
  ),
  NextToken = "string",
  RequestId = "string",
  Status = 123
)

Request syntax¶

svc$search_knowledge_bases(
  AwsAccountId = "string",
  NextToken = "string",
  MaxResults = 123,
  Filters = list(
    list(
      name = "KNOWLEDGE_BASE_ID"|"KNOWLEDGE_BASE_NAME"|"DIRECT_QUICKSIGHT_OWNER"|"DIRECT_QUICKSIGHT_VIEWER_OR_OWNER"|"DIRECT_QUICKSIGHT_SOLE_OWNER"|"KNOWLEDGE_BASE_SIZE_BYTES"|"PRIMARY_OWNER"|"DATASOURCE_ARN",
      operator = "STRING_EQUALS"|"STRING_LIKE"|"GREATER_THAN_OR_EQUALS"|"LESS_THAN_OR_EQUALS",
      value = "string"
    )
  ),
  SortBy = list(
    sortByField = "KNOWLEDGE_BASE_SIZE_BYTES"|"CREATED_AT",
    sortOrder = "ASC"|"DESC"
  )
)