AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . quicksight ]

describe-knowledge-base

Description

Describes a knowledge base.

See also: AWS API Documentation

describe-knowledge-base uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type document must be provided as JSON. Shorthand syntax does not support document types.

Synopsis

  describe-knowledge-base
--aws-account-id <value>
--knowledge-base-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--aws-account-id (string)

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

--knowledge-base-id (string)

The unique identifier for the knowledge base.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

KnowledgeBase -> (structure)

The knowledge base.

KnowledgeBaseArn -> (string)

The Amazon Resource Name (ARN) of the knowledge base.

KnowledgeBaseId -> (string)

The unique identifier for the knowledge base.

Name -> (string)

The name of the knowledge base.

Status -> (string)

The status of the knowledge base.

DataSourceArn -> (string)

The ARN of the data source associated with the knowledge base.

KnowledgeBaseConfiguration -> (structure)

The configuration settings for the knowledge base.

templateConfiguration -> (structure)

The template configuration for the knowledge base.

template -> (document)

The template document that defines the knowledge base behavior.

MediaExtractionConfiguration -> (structure)

The media extraction configuration for the knowledge base.

imageExtractionConfiguration -> (structure)

The configuration for image extraction.

imageExtractionStatus -> (string)

The status of image extraction. Valid values are ENABLED and DISABLED.

audioExtractionConfiguration -> (structure)

The configuration for audio extraction.

audioExtractionStatus -> (string)

The status of audio extraction. Valid values are ENABLED and DISABLED.

videoExtractionConfiguration -> (structure)

The configuration for video extraction.

videoExtractionStatus -> (string)

The status of video extraction. Valid values are ENABLED and DISABLED.

videoExtractionType -> (string)

The type of video extraction to perform.

AccessControlConfiguration -> (structure)

The access control configuration for the knowledge base.

isACLEnabled -> (boolean)

Specifies whether ACLs are enabled for the knowledge base.

Type -> (string)

The type of the knowledge base.

CreatedAt -> (timestamp)

The date and time that the knowledge base was created.

UpdatedAt -> (timestamp)

The date and time that the knowledge base was last updated.

Description -> (string)

The description of the knowledge base.

IsEmailNotificationOptedForIngestionFailures -> (boolean)

Specifies whether email notifications are enabled for ingestion failures.

FirstCompletedIngestionSummary -> (structure)

A summary of the first completed ingestion for the knowledge base.

IngestionId -> (string)

The unique identifier for the ingestion job.

IngestionStatus -> (string)

The status of the ingestion job.

StartTime -> (timestamp)

The start time of the ingestion job.

EndTime -> (timestamp)

The end time of the ingestion job.

FirstIncompleteIngestionSummary -> (structure)

A summary of the first incomplete ingestion for the knowledge base.

IngestionId -> (string)

The unique identifier for the ingestion job.

IngestionStatus -> (string)

The status of the ingestion job.

StartTime -> (timestamp)

The start time of the ingestion job.

EndTime -> (timestamp)

The end time of the ingestion job.

LatestIngestionSummary -> (structure)

A summary of the most recent ingestion for the knowledge base.

IngestionId -> (string)

The unique identifier for the ingestion job.

IngestionStatus -> (string)

The status of the ingestion job.

StartTime -> (timestamp)

The start time of the ingestion job.

EndTime -> (timestamp)

The end time of the ingestion job.

KnowledgeBaseSizeBytes -> (long)

The size of the knowledge base in bytes.

DocumentCount -> (long)

The number of documents in the knowledge base.

PrimaryOwnerArn -> (string)

The ARN of the primary owner of the knowledge base.

PrimaryOwnerUsername -> (string)

The username of the primary owner of the knowledge base.

RequestId -> (string)

The Amazon Web Services request ID for this operation.

Status -> (integer)

The HTTP status of the request.