Skip to content

OneDriveConfiguration

Source code in docs_src/capo_kendra/types/one_drive_configuration.py
class OneDriveConfiguration(TypedDict, closed=True):
    tenant_domain: "capo_kendra.types.tenant_domain.TenantDomain"
    """<p>The Azure Active Directory domain of the organization. </p>"""
    secret_arn: "capo_kendra.types.secret_arn.SecretArn"
    """<p>The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the user name and password to connect to OneDrive. The user name should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.</p>"""
    one_drive_users: "capo_kendra.types.one_drive_users.OneDriveUsers"
    """<p>A list of user accounts whose documents should be indexed.</p>"""
    inclusion_patterns: NotRequired[
        "capo_kendra.types.data_source_inclusions_exclusions_strings.DataSourceInclusionsExclusionsStrings"
    ]
    """<p>A list of regular expression patterns to include certain documents in your OneDrive. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.</p> <p>The pattern is applied to the file name.</p>"""
    exclusion_patterns: NotRequired[
        "capo_kendra.types.data_source_inclusions_exclusions_strings.DataSourceInclusionsExclusionsStrings"
    ]
    """<p>A list of regular expression patterns to exclude certain documents in your OneDrive. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.</p> <p>The pattern is applied to the file name.</p>"""
    field_mappings: NotRequired[
        "capo_kendra.types.data_source_to_index_field_mapping_list.DataSourceToIndexFieldMappingList"
    ]
    """<p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map OneDrive 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 OneDrive fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The OneDrive data source field names must exist in your OneDrive custom metadata.</p>"""
    disable_local_groups: "capo_kendra.types.boolean.Boolean"
    """<p> <code>TRUE</code> to disable local groups information.</p>"""

disable_local_groups instance-attribute

disable_local_groups: Boolean

TRUE to disable local groups information.

exclusion_patterns instance-attribute

exclusion_patterns: NotRequired[DataSourceInclusionsExclusionsStrings]

A list of regular expression patterns to exclude certain documents in your OneDrive. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The pattern is applied to the file name.

field_mappings instance-attribute

field_mappings: NotRequired[DataSourceToIndexFieldMappingList]

A list of DataSourceToIndexFieldMapping objects that map OneDrive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to OneDrive fields. For more information, see Mapping data source fields. The OneDrive data source field names must exist in your OneDrive custom metadata.

inclusion_patterns instance-attribute

inclusion_patterns: NotRequired[DataSourceInclusionsExclusionsStrings]

A list of regular expression patterns to include certain documents in your OneDrive. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The pattern is applied to the file name.

one_drive_users instance-attribute

one_drive_users: OneDriveUsers

A list of user accounts whose documents should be indexed.

secret_arn instance-attribute

secret_arn: SecretArn

The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the user name and password to connect to OneDrive. The user name should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.

tenant_domain instance-attribute

tenant_domain: TenantDomain

The Azure Active Directory domain of the organization.