Skip to content

GoogleDriveConfiguration

Source code in docs_src/capo_kendra/types/google_drive_configuration.py
class GoogleDriveConfiguration(TypedDict, closed=True):
    secret_arn: "capo_kendra.types.secret_arn.SecretArn"
    """<p>The Amazon Resource Name (ARN) of a Secrets Managersecret that contains the credentials required to connect to Google Drive. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html">Using a Google Workspace Drive data source</a>.</p>"""
    inclusion_patterns: NotRequired[
        "capo_kendra.types.data_source_inclusions_exclusions_strings.DataSourceInclusionsExclusionsStrings"
    ]
    """<p>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.</p>"""
    exclusion_patterns: NotRequired[
        "capo_kendra.types.data_source_inclusions_exclusions_strings.DataSourceInclusionsExclusionsStrings"
    ]
    """<p>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.</p>"""
    field_mappings: NotRequired[
        "capo_kendra.types.data_source_to_index_field_mapping_list.DataSourceToIndexFieldMappingList"
    ]
    """<p>Maps Google Drive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to Google Drive fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The Google Drive data source field names must exist in your Google Drive custom metadata.</p>"""
    exclude_mime_types: NotRequired[
        "capo_kendra.types.exclude_mime_types_list.ExcludeMimeTypesList"
    ]
    """<p>A list of MIME types to exclude from the index. All documents matching the specified MIME type are excluded. </p> <p>For a list of MIME types, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html">Using a Google Workspace Drive data source</a>.</p>"""
    exclude_user_accounts: NotRequired[
        "capo_kendra.types.exclude_user_accounts_list.ExcludeUserAccountsList"
    ]
    """<p>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.</p>"""
    exclude_shared_drives: NotRequired[
        "capo_kendra.types.exclude_shared_drives_list.ExcludeSharedDrivesList"
    ]
    """<p>A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded.</p>"""

exclude_mime_types instance-attribute

exclude_mime_types: NotRequired[ExcludeMimeTypesList]

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.

exclude_shared_drives instance-attribute

exclude_shared_drives: NotRequired[ExcludeSharedDrivesList]

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

exclude_user_accounts instance-attribute

exclude_user_accounts: NotRequired[ExcludeUserAccountsList]

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.

exclusion_patterns instance-attribute

exclusion_patterns: NotRequired[DataSourceInclusionsExclusionsStrings]

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.

field_mappings instance-attribute

field_mappings: NotRequired[DataSourceToIndexFieldMappingList]

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.

inclusion_patterns instance-attribute

inclusion_patterns: NotRequired[DataSourceInclusionsExclusionsStrings]

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.

secret_arn instance-attribute

secret_arn: 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.