/AWS1/CL_KNDQUIPCONFIGURATION¶
Provides the configuration information to connect to Quip as your data source.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_domain TYPE /AWS1/KNDDOMAIN /AWS1/KNDDOMAIN¶
The Quip site domain. For example, https://quip-company.quipdomain.com/browse. The domain in this example is "quipdomain".
iv_secretarn TYPE /AWS1/KNDSECRETARN /AWS1/KNDSECRETARN¶
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs that are required to connect to your Quip. The secret must contain a JSON structure with the following keys:
accessToken—The token created in Quip. For more information, see Using a Quip data source.
Optional arguments:¶
iv_crawlfilecomments TYPE /AWS1/KNDBOOLEAN /AWS1/KNDBOOLEAN¶
TRUEto index file comments.
iv_crawlchatrooms TYPE /AWS1/KNDBOOLEAN /AWS1/KNDBOOLEAN¶
TRUEto index the contents of chat rooms.
iv_crawlattachments TYPE /AWS1/KNDBOOLEAN /AWS1/KNDBOOLEAN¶
TRUEto index attachments.
it_folderids TYPE /AWS1/CL_KNDFOLDERIDLIST_W=>TT_FOLDERIDLIST TT_FOLDERIDLIST¶
The identifiers of the Quip folders you want to index. You can find the folder ID in your browser URL when you access your folder in Quip. For example, https://quip-company.quipdomain.com/zlLuOVNSarTL/folder-name. The folder ID in this example is "zlLuOVNSarTL".
it_threadfieldmappings TYPE /AWS1/CL_KNDDATASRCTOIDXFIEL00=>TT_DATASRCTOINDEXFIELDMAPLIST TT_DATASRCTOINDEXFIELDMAPLIST¶
A list of
DataSourceToIndexFieldMappingobjects that map attributes or field names of Quip threads to Amazon Kendra index field names. To create custom fields, use theUpdateIndexAPI before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.
it_messagefieldmappings TYPE /AWS1/CL_KNDDATASRCTOIDXFIEL00=>TT_DATASRCTOINDEXFIELDMAPLIST TT_DATASRCTOINDEXFIELDMAPLIST¶
A list of
DataSourceToIndexFieldMappingobjects that map attributes or field names of Quip messages to Amazon Kendra index field names. To create custom fields, use theUpdateIndexAPI before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.
it_attachmentfieldmappings TYPE /AWS1/CL_KNDDATASRCTOIDXFIEL00=>TT_DATASRCTOINDEXFIELDMAPLIST TT_DATASRCTOINDEXFIELDMAPLIST¶
A list of
DataSourceToIndexFieldMappingobjects that map attributes or field names of Quip attachments to Amazon Kendra index field names. To create custom fields, use theUpdateIndexAPI before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.
it_inclusionpatterns TYPE /AWS1/CL_KNDDATASRCINCLUSION00=>TT_DATASRCINCLUSIONSEXCLUSIO00 TT_DATASRCINCLUSIONSEXCLUSIO00¶
A list of regular expression patterns to include certain files in your Quip file system. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence, and the file isn't included in the index.
it_exclusionpatterns TYPE /AWS1/CL_KNDDATASRCINCLUSION00=>TT_DATASRCINCLUSIONSEXCLUSIO00 TT_DATASRCINCLUSIONSEXCLUSIO00¶
A list of regular expression patterns to exclude certain files in your Quip file system. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence, and the file isn't included in the index.
io_vpcconfiguration TYPE REF TO /AWS1/CL_KNDDATASOURCEVPCCONF /AWS1/CL_KNDDATASOURCEVPCCONF¶
Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip. For more information, see Configuring a VPC.
Queryable Attributes¶
Domain¶
The Quip site domain. For example, https://quip-company.quipdomain.com/browse. The domain in this example is "quipdomain".
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DOMAIN() |
Getter for DOMAIN, with configurable default |
ASK_DOMAIN() |
Getter for DOMAIN w/ exceptions if field has no value |
HAS_DOMAIN() |
Determine if DOMAIN has a value |
SecretArn¶
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs that are required to connect to your Quip. The secret must contain a JSON structure with the following keys:
accessToken—The token created in Quip. For more information, see Using a Quip data source.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SECRETARN() |
Getter for SECRETARN, with configurable default |
ASK_SECRETARN() |
Getter for SECRETARN w/ exceptions if field has no value |
HAS_SECRETARN() |
Determine if SECRETARN has a value |
CrawlFileComments¶
TRUEto index file comments.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CRAWLFILECOMMENTS() |
Getter for CRAWLFILECOMMENTS |
CrawlChatRooms¶
TRUEto index the contents of chat rooms.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CRAWLCHATROOMS() |
Getter for CRAWLCHATROOMS |
CrawlAttachments¶
TRUEto index attachments.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CRAWLATTACHMENTS() |
Getter for CRAWLATTACHMENTS |
FolderIds¶
The identifiers of the Quip folders you want to index. You can find the folder ID in your browser URL when you access your folder in Quip. For example, https://quip-company.quipdomain.com/zlLuOVNSarTL/folder-name. The folder ID in this example is "zlLuOVNSarTL".
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FOLDERIDS() |
Getter for FOLDERIDS, with configurable default |
ASK_FOLDERIDS() |
Getter for FOLDERIDS w/ exceptions if field has no value |
HAS_FOLDERIDS() |
Determine if FOLDERIDS has a value |
ThreadFieldMappings¶
A list of
DataSourceToIndexFieldMappingobjects that map attributes or field names of Quip threads to Amazon Kendra index field names. To create custom fields, use theUpdateIndexAPI before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_THREADFIELDMAPPINGS() |
Getter for THREADFIELDMAPPINGS, with configurable default |
ASK_THREADFIELDMAPPINGS() |
Getter for THREADFIELDMAPPINGS w/ exceptions if field has no |
HAS_THREADFIELDMAPPINGS() |
Determine if THREADFIELDMAPPINGS has a value |
MessageFieldMappings¶
A list of
DataSourceToIndexFieldMappingobjects that map attributes or field names of Quip messages to Amazon Kendra index field names. To create custom fields, use theUpdateIndexAPI before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MESSAGEFIELDMAPPINGS() |
Getter for MESSAGEFIELDMAPPINGS, with configurable default |
ASK_MESSAGEFIELDMAPPINGS() |
Getter for MESSAGEFIELDMAPPINGS w/ exceptions if field has n |
HAS_MESSAGEFIELDMAPPINGS() |
Determine if MESSAGEFIELDMAPPINGS has a value |
AttachmentFieldMappings¶
A list of
DataSourceToIndexFieldMappingobjects that map attributes or field names of Quip attachments to Amazon Kendra index field names. To create custom fields, use theUpdateIndexAPI before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ATTACHMENTFIELDMAPPINGS() |
Getter for ATTACHMENTFIELDMAPPINGS, with configurable defaul |
ASK_ATTACHMENTFIELDMAPPINGS() |
Getter for ATTACHMENTFIELDMAPPINGS w/ exceptions if field ha |
HAS_ATTACHMENTFIELDMAPPINGS() |
Determine if ATTACHMENTFIELDMAPPINGS has a value |
InclusionPatterns¶
A list of regular expression patterns to include certain files in your Quip file system. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence, and the file isn't included in the index.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INCLUSIONPATTERNS() |
Getter for INCLUSIONPATTERNS, with configurable default |
ASK_INCLUSIONPATTERNS() |
Getter for INCLUSIONPATTERNS w/ exceptions if field has no v |
HAS_INCLUSIONPATTERNS() |
Determine if INCLUSIONPATTERNS has a value |
ExclusionPatterns¶
A list of regular expression patterns to exclude certain files in your Quip file system. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence, and the file isn't included in the index.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXCLUSIONPATTERNS() |
Getter for EXCLUSIONPATTERNS, with configurable default |
ASK_EXCLUSIONPATTERNS() |
Getter for EXCLUSIONPATTERNS w/ exceptions if field has no v |
HAS_EXCLUSIONPATTERNS() |
Determine if EXCLUSIONPATTERNS has a value |
VpcConfiguration¶
Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip. For more information, see Configuring a VPC.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VPCCONFIGURATION() |
Getter for VPCCONFIGURATION |