amazonka-kendra-2.0: Amazon KendraFrontendService SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Kendra.Types.GoogleDriveConfiguration

Description

 
Synopsis

Documentation

data GoogleDriveConfiguration Source #

Provides the configuration information to connect to Google Drive as your data source.

See: newGoogleDriveConfiguration smart constructor.

Constructors

GoogleDriveConfiguration' 

Fields

  • excludeMimeTypes :: Maybe [Text]

    A list of MIME types to exclude from the index. All documents matching the specified MIME type are excluded.

    For a list of MIME types, see Using a Google Workspace Drive data source.

  • excludeSharedDrives :: Maybe [Text]

    A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded.

  • excludeUserAccounts :: Maybe [Text]

    A list of email addresses of the users. Documents owned by these users are excluded from the index. Documents shared with excluded users are indexed unless they are excluded in another way.

  • exclusionPatterns :: Maybe [Text]

    A list of regular expression patterns to exclude certain items in your Google Drive, including shared drives and users' My Drives. Items that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

  • fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)

    Maps Google Drive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Google Drive fields. For more information, see Mapping data source fields. The Google Drive data source field names must exist in your Google Drive custom metadata.

  • inclusionPatterns :: Maybe [Text]

    A list of regular expression patterns to include certain items in your Google Drive, including shared drives and users' My Drives. Items that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

  • secretArn :: Text

    The Amazon Resource Name (ARN) of a Secrets Managersecret that contains the credentials required to connect to Google Drive. For more information, see Using a Google Workspace Drive data source.

Instances

Instances details
FromJSON GoogleDriveConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.GoogleDriveConfiguration

ToJSON GoogleDriveConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.GoogleDriveConfiguration

Generic GoogleDriveConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.GoogleDriveConfiguration

Associated Types

type Rep GoogleDriveConfiguration :: Type -> Type #

Read GoogleDriveConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.GoogleDriveConfiguration

Show GoogleDriveConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.GoogleDriveConfiguration

NFData GoogleDriveConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.GoogleDriveConfiguration

Eq GoogleDriveConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.GoogleDriveConfiguration

Hashable GoogleDriveConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.GoogleDriveConfiguration

type Rep GoogleDriveConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.GoogleDriveConfiguration

type Rep GoogleDriveConfiguration = D1 ('MetaData "GoogleDriveConfiguration" "Amazonka.Kendra.Types.GoogleDriveConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "GoogleDriveConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "excludeMimeTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "excludeSharedDrives") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "excludeUserAccounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 ('MetaSel ('Just "exclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping)))) :*: (S1 ('MetaSel ('Just "inclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGoogleDriveConfiguration Source #

Create a value of GoogleDriveConfiguration 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:excludeMimeTypes:GoogleDriveConfiguration', googleDriveConfiguration_excludeMimeTypes - A list of MIME types to exclude from the index. All documents matching the specified MIME type are excluded.

For a list of MIME types, see Using a Google Workspace Drive data source.

$sel:excludeSharedDrives:GoogleDriveConfiguration', googleDriveConfiguration_excludeSharedDrives - A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded.

$sel:excludeUserAccounts:GoogleDriveConfiguration', googleDriveConfiguration_excludeUserAccounts - A list of email addresses of the users. Documents owned by these users are excluded from the index. Documents shared with excluded users are indexed unless they are excluded in another way.

$sel:exclusionPatterns:GoogleDriveConfiguration', googleDriveConfiguration_exclusionPatterns - A list of regular expression patterns to exclude certain items in your Google Drive, including shared drives and users' My Drives. Items that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

$sel:fieldMappings:GoogleDriveConfiguration', googleDriveConfiguration_fieldMappings - Maps Google Drive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Google Drive fields. For more information, see Mapping data source fields. The Google Drive data source field names must exist in your Google Drive custom metadata.

$sel:inclusionPatterns:GoogleDriveConfiguration', googleDriveConfiguration_inclusionPatterns - A list of regular expression patterns to include certain items in your Google Drive, including shared drives and users' My Drives. Items that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

$sel:secretArn:GoogleDriveConfiguration', googleDriveConfiguration_secretArn - The Amazon Resource Name (ARN) of a Secrets Managersecret that contains the credentials required to connect to Google Drive. For more information, see Using a Google Workspace Drive data source.

googleDriveConfiguration_excludeMimeTypes :: Lens' GoogleDriveConfiguration (Maybe [Text]) Source #

A list of MIME types to exclude from the index. All documents matching the specified MIME type are excluded.

For a list of MIME types, see Using a Google Workspace Drive data source.

googleDriveConfiguration_excludeSharedDrives :: Lens' GoogleDriveConfiguration (Maybe [Text]) Source #

A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded.

googleDriveConfiguration_excludeUserAccounts :: Lens' GoogleDriveConfiguration (Maybe [Text]) Source #

A list of email addresses of the users. Documents owned by these users are excluded from the index. Documents shared with excluded users are indexed unless they are excluded in another way.

googleDriveConfiguration_exclusionPatterns :: Lens' GoogleDriveConfiguration (Maybe [Text]) Source #

A list of regular expression patterns to exclude certain items in your Google Drive, including shared drives and users' My Drives. Items that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

googleDriveConfiguration_fieldMappings :: Lens' GoogleDriveConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

Maps Google Drive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Google Drive fields. For more information, see Mapping data source fields. The Google Drive data source field names must exist in your Google Drive custom metadata.

googleDriveConfiguration_inclusionPatterns :: Lens' GoogleDriveConfiguration (Maybe [Text]) Source #

A list of regular expression patterns to include certain items in your Google Drive, including shared drives and users' My Drives. Items that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

googleDriveConfiguration_secretArn :: Lens' GoogleDriveConfiguration Text Source #

The Amazon Resource Name (ARN) of a Secrets Managersecret that contains the credentials required to connect to Google Drive. For more information, see Using a Google Workspace Drive data source.