Class: Aws::Kendra::Types::QuipConfiguration

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kendra/types.rb

Overview

Provides the configuration information to connect to Quip as your data source.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attachment_field_mappingsArray<Types::DataSourceToIndexFieldMapping>

A list of ‘DataSourceToIndexFieldMapping` objects that map attributes or field names of Quip attachments to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API 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.

[1]: docs.aws.amazon.com/kendra/latest/dg/field-mapping.html



8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
# File 'lib/aws-sdk-kendra/types.rb', line 8308

class QuipConfiguration < Struct.new(
  :domain,
  :secret_arn,
  :crawl_file_comments,
  :crawl_chat_rooms,
  :crawl_attachments,
  :folder_ids,
  :thread_field_mappings,
  :message_field_mappings,
  :attachment_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#crawl_attachmentsBoolean

‘TRUE` to index attachments.

Returns:

  • (Boolean)


8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
# File 'lib/aws-sdk-kendra/types.rb', line 8308

class QuipConfiguration < Struct.new(
  :domain,
  :secret_arn,
  :crawl_file_comments,
  :crawl_chat_rooms,
  :crawl_attachments,
  :folder_ids,
  :thread_field_mappings,
  :message_field_mappings,
  :attachment_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#crawl_chat_roomsBoolean

‘TRUE` to index the contents of chat rooms.

Returns:

  • (Boolean)


8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
# File 'lib/aws-sdk-kendra/types.rb', line 8308

class QuipConfiguration < Struct.new(
  :domain,
  :secret_arn,
  :crawl_file_comments,
  :crawl_chat_rooms,
  :crawl_attachments,
  :folder_ids,
  :thread_field_mappings,
  :message_field_mappings,
  :attachment_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#crawl_file_commentsBoolean

‘TRUE` to index file comments.

Returns:

  • (Boolean)


8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
# File 'lib/aws-sdk-kendra/types.rb', line 8308

class QuipConfiguration < Struct.new(
  :domain,
  :secret_arn,
  :crawl_file_comments,
  :crawl_chat_rooms,
  :crawl_attachments,
  :folder_ids,
  :thread_field_mappings,
  :message_field_mappings,
  :attachment_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#domainString

The Quip site domain. For example, https://quip-company.quipdomain.com/browse. The domain in this example is “quipdomain”.

Returns:

  • (String)


8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
# File 'lib/aws-sdk-kendra/types.rb', line 8308

class QuipConfiguration < Struct.new(
  :domain,
  :secret_arn,
  :crawl_file_comments,
  :crawl_chat_rooms,
  :crawl_attachments,
  :folder_ids,
  :thread_field_mappings,
  :message_field_mappings,
  :attachment_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#exclusion_patternsArray<String>

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.

Returns:

  • (Array<String>)


8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
# File 'lib/aws-sdk-kendra/types.rb', line 8308

class QuipConfiguration < Struct.new(
  :domain,
  :secret_arn,
  :crawl_file_comments,
  :crawl_chat_rooms,
  :crawl_attachments,
  :folder_ids,
  :thread_field_mappings,
  :message_field_mappings,
  :attachment_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#folder_idsArray<String>

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

Returns:

  • (Array<String>)


8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
# File 'lib/aws-sdk-kendra/types.rb', line 8308

class QuipConfiguration < Struct.new(
  :domain,
  :secret_arn,
  :crawl_file_comments,
  :crawl_chat_rooms,
  :crawl_attachments,
  :folder_ids,
  :thread_field_mappings,
  :message_field_mappings,
  :attachment_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#inclusion_patternsArray<String>

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.

Returns:

  • (Array<String>)


8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
# File 'lib/aws-sdk-kendra/types.rb', line 8308

class QuipConfiguration < Struct.new(
  :domain,
  :secret_arn,
  :crawl_file_comments,
  :crawl_chat_rooms,
  :crawl_attachments,
  :folder_ids,
  :thread_field_mappings,
  :message_field_mappings,
  :attachment_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#message_field_mappingsArray<Types::DataSourceToIndexFieldMapping>

A list of ‘DataSourceToIndexFieldMapping` objects that map attributes or field names of Quip messages to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API 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.

[1]: docs.aws.amazon.com/kendra/latest/dg/field-mapping.html



8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
# File 'lib/aws-sdk-kendra/types.rb', line 8308

class QuipConfiguration < Struct.new(
  :domain,
  :secret_arn,
  :crawl_file_comments,
  :crawl_chat_rooms,
  :crawl_attachments,
  :folder_ids,
  :thread_field_mappings,
  :message_field_mappings,
  :attachment_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arnString

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

^

[1]: docs.aws.amazon.com/kendra/latest/dg/data-source-slack.html

Returns:

  • (String)


8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
# File 'lib/aws-sdk-kendra/types.rb', line 8308

class QuipConfiguration < Struct.new(
  :domain,
  :secret_arn,
  :crawl_file_comments,
  :crawl_chat_rooms,
  :crawl_attachments,
  :folder_ids,
  :thread_field_mappings,
  :message_field_mappings,
  :attachment_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#thread_field_mappingsArray<Types::DataSourceToIndexFieldMapping>

A list of ‘DataSourceToIndexFieldMapping` objects that map attributes or field names of Quip threads to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API 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.

[1]: docs.aws.amazon.com/kendra/latest/dg/field-mapping.html



8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
# File 'lib/aws-sdk-kendra/types.rb', line 8308

class QuipConfiguration < Struct.new(
  :domain,
  :secret_arn,
  :crawl_file_comments,
  :crawl_chat_rooms,
  :crawl_attachments,
  :folder_ids,
  :thread_field_mappings,
  :message_field_mappings,
  :attachment_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_configurationTypes::DataSourceVpcConfiguration

Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip. For more information, see [Configuring a VPC].

[1]: docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html



8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
# File 'lib/aws-sdk-kendra/types.rb', line 8308

class QuipConfiguration < Struct.new(
  :domain,
  :secret_arn,
  :crawl_file_comments,
  :crawl_chat_rooms,
  :crawl_attachments,
  :folder_ids,
  :thread_field_mappings,
  :message_field_mappings,
  :attachment_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end