Describes a knowledge base¶

Description¶

Describes a knowledge base.

Usage¶

quicksight_describe_knowledge_base(AwsAccountId, KnowledgeBaseId)

Arguments¶

AwsAccountId

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

KnowledgeBaseId

[required] The unique identifier for the knowledge base.

Value¶

A list with the following syntax:

list(
  KnowledgeBase = list(
    KnowledgeBaseArn = "string",
    KnowledgeBaseId = "string",
    Name = "string",
    Status = "CREATING"|"UPDATING"|"ACTIVE"|"FAILED"|"DELETING",
    DataSourceArn = "string",
    KnowledgeBaseConfiguration = list(
      templateConfiguration = list(
        template = list()
      )
    ),
    MediaExtractionConfiguration = list(
      imageExtractionConfiguration = list(
        imageExtractionStatus = "ENABLED"|"DISABLED"
      ),
      audioExtractionConfiguration = list(
        audioExtractionStatus = "ENABLED"|"DISABLED"
      ),
      videoExtractionConfiguration = list(
        videoExtractionStatus = "ENABLED"|"DISABLED",
        videoExtractionType = "AUDIO_TRANSCRIPTION_ONLY"|"VISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION"
      )
    ),
    AccessControlConfiguration = list(
      isACLEnabled = TRUE|FALSE
    ),
    Type = "string",
    CreatedAt = as.POSIXct(
      "2015-01-01"
    ),
    UpdatedAt = as.POSIXct(
      "2015-01-01"
    ),
    Description = "string",
    IsEmailNotificationOptedForIngestionFailures = TRUE|FALSE,
    FirstCompletedIngestionSummary = list(
      IngestionId = "string",
      IngestionStatus = "QUEUED"|"RUNNING"|"FAILED"|"COMPLETED"|"INCOMPLETE"|"CANCELLED"|"CANCELLING"|"TIMEOUT",
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      EndTime = as.POSIXct(
        "2015-01-01"
      )
    ),
    FirstIncompleteIngestionSummary = list(
      IngestionId = "string",
      IngestionStatus = "QUEUED"|"RUNNING"|"FAILED"|"COMPLETED"|"INCOMPLETE"|"CANCELLED"|"CANCELLING"|"TIMEOUT",
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      EndTime = as.POSIXct(
        "2015-01-01"
      )
    ),
    LatestIngestionSummary = list(
      IngestionId = "string",
      IngestionStatus = "QUEUED"|"RUNNING"|"FAILED"|"COMPLETED"|"INCOMPLETE"|"CANCELLED"|"CANCELLING"|"TIMEOUT",
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      EndTime = as.POSIXct(
        "2015-01-01"
      )
    ),
    KnowledgeBaseSizeBytes = 123,
    DocumentCount = 123,
    PrimaryOwnerArn = "string",
    PrimaryOwnerUsername = "string"
  ),
  RequestId = "string",
  Status = 123
)

Request syntax¶

svc$describe_knowledge_base(
  AwsAccountId = "string",
  KnowledgeBaseId = "string"
)