DataSource
Contains details about a data source.
Contents
- createdAt
-
The time at which the data source was created.
Type: Timestamp
Required: Yes
- dataSourceConfiguration
-
The connection configuration for the data source.
Type: DataSourceConfiguration object
Required: Yes
- dataSourceId
-
The unique identifier of the data source.
Type: String
Pattern:
^[0-9a-zA-Z]{10}$Required: Yes
- knowledgeBaseId
-
The unique identifier of the knowledge base to which the data source belongs.
Type: String
Pattern:
^[0-9a-zA-Z]{10}$Required: Yes
- name
-
The name of the data source.
Type: String
Pattern:
^([0-9a-zA-Z][_-]?){1,100}$Required: Yes
- status
-
The status of the data source. The following statuses are possible:
-
Available – The data source has been created and is ready for ingestion into the knowledge base.
-
Deleting – The data source is being deleted.
Type: String
Valid Values:
AVAILABLE | DELETING | DELETE_UNSUCCESSFULRequired: Yes
-
- updatedAt
-
The time at which the data source was last updated.
Type: Timestamp
Required: Yes
- dataDeletionPolicy
-
The data deletion policy for the data source.
Type: String
Valid Values:
RETAIN | DELETERequired: No
- description
-
The description of the data source.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
- failureReasons
-
The detailed reasons on the failure to delete a data source.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 2048 items.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
- serverSideEncryptionConfiguration
-
Contains details about the configuration of the server-side encryption.
Type: ServerSideEncryptionConfiguration object
Required: No
- vectorIngestionConfiguration
-
Contains details about how to ingest the documents in the data source.
Type: VectorIngestionConfiguration object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
