describe-knowledge-base¶

Description¶

Describes a knowledge base.

Synopsis¶

  describe-knowledge-base
--aws-account-id <value>
--knowledge-base-id <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--aws-account-id (string) [required]

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

Constraints:

min: 12

max: 12

pattern: [0-9]*

--knowledge-base-id (string) [required]

The unique identifier for the knowledge base.

Constraints:

min: 1

max: 1024

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
yaml
yaml-stream
off

--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.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

KnowledgeBase -> (structure)

The knowledge base.

KnowledgeBaseArn -> (string) [required]

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

Constraints:

min: 0

max: 1284

pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

KnowledgeBaseId -> (string) [required]

The unique identifier for the knowledge base.

Constraints:

min: 1

max: 1024

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

Name -> (string) [required]

The name of the knowledge base.

Constraints:

min: 0

max: 128

pattern: [\p{L}\p{N}][\p{L}\p{N} _\-\.]*

Status -> (string) [required]

The status of the knowledge base.

Possible values:

CREATING

UPDATING

ACTIVE

FAILED

DELETING

DataSourceArn -> (string) [required]

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

Constraints:

min: 0

max: 1284

pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

KnowledgeBaseConfiguration -> (structure) [required]

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.

eventEnabled -> (boolean)

Indicates whether event notifications are enabled for the knowledge base.

MediaExtractionConfiguration -> (structure)

The media extraction configuration for the knowledge base.

imageExtractionConfiguration -> (structure)

The configuration for image extraction.

imageExtractionStatus -> (string) [required]

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

Possible values:

ENABLED

DISABLED

audioExtractionConfiguration -> (structure)

The configuration for audio extraction.

audioExtractionStatus -> (string) [required]

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

Possible values:

ENABLED

DISABLED

videoExtractionConfiguration -> (structure)

The configuration for video extraction.

videoExtractionStatus -> (string) [required]

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

Possible values:

ENABLED

DISABLED

videoExtractionType -> (string)

The type of video extraction to perform.

Possible values:

AUDIO_TRANSCRIPTION_ONLY

VISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION

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.

Constraints:

min: 0

max: 1000

pattern: \P{C}*

IsEmailNotificationOptedForIngestionFailures -> (boolean)

Indicates whether email notifications are enabled for ingestion failures.

FirstCompletedIngestionSummary -> (structure)

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

IngestionId -> (string) [required]

The unique identifier for the ingestion job.

Constraints:

min: 1

max: 1024

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

IngestionStatus -> (string) [required]

The status of the ingestion job.

Possible values:

QUEUED

RUNNING

FAILED

COMPLETED

INCOMPLETE

CANCELLED

CANCELLING

TIMEOUT

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) [required]

The unique identifier for the ingestion job.

Constraints:

min: 1

max: 1024

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

IngestionStatus -> (string) [required]

The status of the ingestion job.

Possible values:

QUEUED

RUNNING

FAILED

COMPLETED

INCOMPLETE

CANCELLED

CANCELLING

TIMEOUT

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) [required]

The unique identifier for the ingestion job.

Constraints:

min: 1

max: 1024

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

IngestionStatus -> (string) [required]

The status of the ingestion job.

Possible values:

QUEUED

RUNNING

FAILED

COMPLETED

INCOMPLETE

CANCELLED

CANCELLING

TIMEOUT

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.

Table of Contents

Feedback

User Guide