Skip to content

S3KnowledgeBaseParameters

Source code in docs_src/capo_quicksight/types/s3_knowledge_base_parameters.py 
15
16
17
18
19
20
21
22
23
class S3KnowledgeBaseParameters(TypedDict, closed=True):
    role_arn: NotRequired["capo_quicksight.types.role_arn.RoleArn"]
    """<p>Use the <code>RoleArn</code> structure to override an account-wide role for a specific S3 Knowledge Base data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use <code>RoleArn</code> to bypass the account-wide role and allow S3 access for the single S3 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.</p>"""
    bucket_url: "capo_quicksight.types.s3_bucket.S3Bucket"
    """<p>The URL of the S3 bucket that contains the knowledge base data.</p>"""
    metadata_files_location: NotRequired[
        "capo_quicksight.types.metadata_files_location.MetadataFilesLocation"
    ]
    """<p>The Amazon S3 location (prefix) of per-document metadata files. Each metadata file describes a single source document and its indexable attributes, such as title, category, and version. This is not the global ACL configuration file. To apply a single global ACL file to the entire knowledge base, use the access control configuration instead.</p>"""

bucket_url instance-attribute 

bucket_url: S3Bucket

The URL of the S3 bucket that contains the knowledge base data.

metadata_files_location instance-attribute 

metadata_files_location: NotRequired[MetadataFilesLocation]

The Amazon S3 location (prefix) of per-document metadata files. Each metadata file describes a single source document and its indexable attributes, such as title, category, and version. This is not the global ACL configuration file. To apply a single global ACL file to the entire knowledge base, use the access control configuration instead.

role_arn instance-attribute 

role_arn: NotRequired[RoleArn]

Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.