Skip to content

CreateThesaurusRequest

Source code in docs_src/capo_kendra/types/create_thesaurus_request.py
class CreateThesaurusRequest(TypedDict, closed=True):
    index_id: "capo_kendra.types.index_id.IndexId"
    """<p>The identifier of the index for the thesaurus.</p>"""
    name: "capo_kendra.types.thesaurus_name.ThesaurusName"
    """<p>A name for the thesaurus.</p>"""
    description: NotRequired["capo_kendra.types.description.Description"]
    """<p>A description for the thesaurus.</p>"""
    role_arn: "capo_kendra.types.role_arn.RoleArn"
    """<p>The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket that contains the thesaurus file. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM access roles for Amazon Kendra</a>.</p>"""
    tags: NotRequired["capo_kendra.types.tag_list.TagList"]
    """<p>A list of key-value pairs that identify or categorize the thesaurus. You can also use tags to help control access to the thesaurus. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.</p>"""
    source_s3_path: "capo_kendra.types.s3_path.S3Path"
    """<p>The path to the thesaurus file in S3.</p>"""
    client_token: NotRequired["capo_kendra.types.client_token_name.ClientTokenName"]
    """<p>A token that you provide to identify the request to create a thesaurus. Multiple calls to the <code>CreateThesaurus</code> API with the same client token will create only one thesaurus. </p>"""

client_token instance-attribute

client_token: NotRequired[ClientTokenName]

A token that you provide to identify the request to create a thesaurus. Multiple calls to the CreateThesaurus API with the same client token will create only one thesaurus.

description instance-attribute

description: NotRequired[Description]

A description for the thesaurus.

index_id instance-attribute

index_id: IndexId

The identifier of the index for the thesaurus.

name instance-attribute

A name for the thesaurus.

role_arn instance-attribute

role_arn: RoleArn

The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket that contains the thesaurus file. For more information, see IAM access roles for Amazon Kendra.

source_s3_path instance-attribute

source_s3_path: S3Path

The path to the thesaurus file in S3.

tags instance-attribute

tags: NotRequired[TagList]

A list of key-value pairs that identify or categorize the thesaurus. You can also use tags to help control access to the thesaurus. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.