S3DataSourceConfiguration ¶

class S3DataSourceConfiguration(TypedDict, closed=True):
    bucket_name: "capo_kendra.types.s3_bucket_name.S3BucketName"
    """<p>The name of the bucket that contains the documents.</p>"""
    inclusion_prefixes: NotRequired[
        "capo_kendra.types.data_source_inclusions_exclusions_strings.DataSourceInclusionsExclusionsStrings"
    ]
    """<p>A list of S3 prefixes for the documents that should be included in the index.</p>"""
    inclusion_patterns: NotRequired[
        "capo_kendra.types.data_source_inclusions_exclusions_strings.DataSourceInclusionsExclusionsStrings"
    ]
    """<p>A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to include in your index. If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include:</p> <ul> <li> <p> <i>/myapp/config/*</i>—All files inside config directory.</p> </li> <li> <p> <i>**/*.png</i>—All .png files in all directories.</p> </li> <li> <p> <i>**/*.{png, ico, md}</i>—All .png, .ico or .md files in all directories.</p> </li> <li> <p> <i>/myapp/src/**/*.ts</i>—All .ts files inside src directory (and all its subdirectories).</p> </li> <li> <p> <i>**/!(*.module).ts</i>—All .ts files but not .module.ts</p> </li> <li> <p> <i>*.png , *.jpg</i>—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).</p> </li> <li> <p> <i>*internal*</i>—All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.</p> </li> <li> <p> <i>**/*internal*</i>—All internal-related files in a directory and its subdirectories.</p> </li> </ul> <p>For more examples, see <a href="https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters">Use of Exclude and Include Filters</a> in the Amazon Web Services CLI Command Reference.</p>"""
    exclusion_patterns: NotRequired[
        "capo_kendra.types.data_source_inclusions_exclusions_strings.DataSourceInclusionsExclusionsStrings"
    ]
    """<p>A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to exclude from your index. If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include:</p> <ul> <li> <p> <i>/myapp/config/*</i>—All files inside config directory.</p> </li> <li> <p> <i>**/*.png</i>—All .png files in all directories.</p> </li> <li> <p> <i>**/*.{png, ico, md}</i>—All .png, .ico or .md files in all directories.</p> </li> <li> <p> <i>/myapp/src/**/*.ts</i>—All .ts files inside src directory (and all its subdirectories).</p> </li> <li> <p> <i>**/!(*.module).ts</i>—All .ts files but not .module.ts</p> </li> <li> <p> <i>*.png , *.jpg</i>—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).</p> </li> <li> <p> <i>*internal*</i>—All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.</p> </li> <li> <p> <i>**/*internal*</i>—All internal-related files in a directory and its subdirectories.</p> </li> </ul> <p>For more examples, see <a href="https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters">Use of Exclude and Include Filters</a> in the Amazon Web Services CLI Command Reference.</p>"""
    documents_metadata_configuration: NotRequired[
        "capo_kendra.types.documents_metadata_configuration.DocumentsMetadataConfiguration"
    ]
    access_control_list_configuration: NotRequired[
        "capo_kendra.types.access_control_list_configuration.AccessControlListConfiguration"
    ]
    """<p>Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html">Access control for S3 data sources</a>.</p>"""