KnowledgeBaseSummary
A summary of a knowledge base, including its identifier, name, status, and metadata.
Contents
Note
In the following list, the required parameters are described first.
- DataSourceArn
-
The ARN of the data source associated with the knowledge base.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 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}Required: Yes
- KnowledgeBaseArn
-
The Amazon Resource Name (ARN) of the knowledge base.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 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}Required: Yes
- KnowledgeBaseId
-
The unique identifier for the knowledge base.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[0-9a-zA-Z-_=.+]+Required: Yes
- Name
-
The name of the knowledge base.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern:
[\p{L}\p{N}][\p{L}\p{N} _\-\.]*Required: Yes
- Status
-
The status of the knowledge base.
Type: String
Valid Values:
CREATING | UPDATING | ACTIVE | FAILED | DELETINGRequired: Yes
- CreatedAt
-
The date and time that the knowledge base was created.
Type: Timestamp
Required: No
- DocumentCount
-
The number of documents in the knowledge base.
Type: Long
Required: No
- KnowledgeBaseSizeBytes
-
The size of the knowledge base in bytes.
Type: Long
Required: No
- PrimaryOwnerArn
-
The ARN of the primary owner of the knowledge base.
Type: String
Required: No
- PrimaryOwnerUsername
-
The username of the primary owner of the knowledge base.
Type: String
Required: No
- Type
-
The type of the knowledge base.
Type: String
Required: No
- UpdatedAt
-
The date and time that the knowledge base was last updated.
Type: Timestamp
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
