Amazonka.Kendra.Types.QuipConfiguration

Documentation

data QuipConfiguration

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

See: newQuipConfiguration smart constructor.

Constructors

QuipConfiguration'

Fields

• attachmentFieldMappings :: Maybe (NonEmpty 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.

• crawlAttachments :: Maybe Bool

  TRUE to index attachments.

• crawlChatRooms :: Maybe Bool

  TRUE to index the contents of chat rooms.

• crawlFileComments :: Maybe Bool

  TRUE to index file comments.

• exclusionPatterns :: Maybe [Text]

  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.

• folderIds :: Maybe [Text]

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

• inclusionPatterns :: Maybe [Text]

  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.

• messageFieldMappings :: Maybe (NonEmpty 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.

• threadFieldMappings :: Maybe (NonEmpty 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.

• vpcConfiguration :: Maybe DataSourceVpcConfiguration

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

• domain :: Text

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

• secretArn :: Text

  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.

Instances

FromJSON QuipConfiguration

Defined in Amazonka.Kendra.Types.QuipConfiguration

Methods

parseJSON :: Value -> Parser QuipConfiguration

parseJSONList :: Value -> Parser [QuipConfiguration]

ToJSON QuipConfiguration

Defined in Amazonka.Kendra.Types.QuipConfiguration

Methods

toJSON :: QuipConfiguration -> Value

toEncoding :: QuipConfiguration -> Encoding

toJSONList :: [QuipConfiguration] -> Value

toEncodingList :: [QuipConfiguration] -> Encoding

Generic QuipConfiguration

Defined in Amazonka.Kendra.Types.QuipConfiguration

Associated Types

type Rep QuipConfiguration :: Type -> Type

Methods

from :: QuipConfiguration -> Rep QuipConfiguration x

to :: Rep QuipConfiguration x -> QuipConfiguration

Read QuipConfiguration

Defined in Amazonka.Kendra.Types.QuipConfiguration

Methods

readsPrec :: Int -> ReadS QuipConfiguration

readList :: ReadS [QuipConfiguration]

readPrec :: ReadPrec QuipConfiguration

readListPrec :: ReadPrec [QuipConfiguration]

Show QuipConfiguration

Defined in Amazonka.Kendra.Types.QuipConfiguration

Methods

showsPrec :: Int -> QuipConfiguration -> ShowS

show :: QuipConfiguration -> String

showList :: [QuipConfiguration] -> ShowS

NFData QuipConfiguration

Defined in Amazonka.Kendra.Types.QuipConfiguration

Methods

rnf :: QuipConfiguration -> ()

Eq QuipConfiguration

Defined in Amazonka.Kendra.Types.QuipConfiguration

Methods

(==) :: QuipConfiguration -> QuipConfiguration -> Bool

(/=) :: QuipConfiguration -> QuipConfiguration -> Bool

Hashable QuipConfiguration

Defined in Amazonka.Kendra.Types.QuipConfiguration

Methods

hashWithSalt :: Int -> QuipConfiguration -> Int

hash :: QuipConfiguration -> Int

type Rep QuipConfiguration

Defined in Amazonka.Kendra.Types.QuipConfiguration

type Rep QuipConfiguration = D1 ('MetaData "QuipConfiguration" "Amazonka.Kendra.Types.QuipConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "QuipConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "attachmentFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :*: (S1 ('MetaSel ('Just "crawlAttachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "crawlChatRooms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "crawlFileComments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "exclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "folderIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :*: ((S1 ('MetaSel ('Just "inclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "messageFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :*: S1 ('MetaSel ('Just "threadFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))))) :*: (S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceVpcConfiguration)) :*: (S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newQuipConfiguration

Arguments

:: Text

$sel:domain:QuipConfiguration'

-> Text

$sel:secretArn:QuipConfiguration'

-> QuipConfiguration

Create a value of QuipConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attachmentFieldMappings:QuipConfiguration', quipConfiguration_attachmentFieldMappings - 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.

$sel:crawlAttachments:QuipConfiguration', quipConfiguration_crawlAttachments - TRUE to index attachments.

$sel:crawlChatRooms:QuipConfiguration', quipConfiguration_crawlChatRooms - TRUE to index the contents of chat rooms.

$sel:crawlFileComments:QuipConfiguration', quipConfiguration_crawlFileComments - TRUE to index file comments.

$sel:exclusionPatterns:QuipConfiguration', quipConfiguration_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.

$sel:folderIds:QuipConfiguration', quipConfiguration_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".

$sel:inclusionPatterns:QuipConfiguration', quipConfiguration_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.

$sel:messageFieldMappings:QuipConfiguration', quipConfiguration_messageFieldMappings - 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.

$sel:threadFieldMappings:QuipConfiguration', quipConfiguration_threadFieldMappings - 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.

$sel:vpcConfiguration:QuipConfiguration', quipConfiguration_vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip. For more information, see Configuring a VPC.

$sel:domain:QuipConfiguration', quipConfiguration_domain - The Quip site domain. For example, https://quip-company.quipdomain.com/browse. The domain in this example is "quipdomain".

$sel:secretArn:QuipConfiguration', quipConfiguration_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.

quipConfiguration_attachmentFieldMappings :: Lens' QuipConfiguration (Maybe (NonEmpty 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.

quipConfiguration_crawlAttachments :: Lens' QuipConfiguration (Maybe Bool)

TRUE to index attachments.

quipConfiguration_crawlChatRooms :: Lens' QuipConfiguration (Maybe Bool)

TRUE to index the contents of chat rooms.

quipConfiguration_crawlFileComments :: Lens' QuipConfiguration (Maybe Bool)

TRUE to index file comments.

quipConfiguration_exclusionPatterns :: Lens' QuipConfiguration (Maybe [Text])

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.

quipConfiguration_folderIds :: Lens' QuipConfiguration (Maybe [Text])

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

quipConfiguration_inclusionPatterns :: Lens' QuipConfiguration (Maybe [Text])

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.

quipConfiguration_messageFieldMappings :: Lens' QuipConfiguration (Maybe (NonEmpty 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.

quipConfiguration_threadFieldMappings :: Lens' QuipConfiguration (Maybe (NonEmpty 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.

quipConfiguration_vpcConfiguration :: Lens' QuipConfiguration (Maybe DataSourceVpcConfiguration)

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

quipConfiguration_domain :: Lens' QuipConfiguration Text

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

quipConfiguration_secretArn :: Lens' QuipConfiguration Text

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.