update_thesaurus

update_thesaurus(**kwargs)

Updates a thesaurus for an index.

See also: AWS API Documentation

Request Syntax

response = client.update_thesaurus(
    Id='string',
    Name='string',
    IndexId='string',
    Description='string',
    RoleArn='string',
    SourceS3Path={
        'Bucket': 'string',
        'Key': 'string'
    }
)
Parameters
  • Id (string) --

    [REQUIRED]

    The identifier of the thesaurus you want to update.

  • Name (string) -- A new name for the thesaurus.
  • IndexId (string) --

    [REQUIRED]

    The identifier of the index for the thesaurus.

  • Description (string) -- A new description for the thesaurus.
  • RoleArn (string) -- An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path .
  • SourceS3Path (dict) --

    Information required to find a specific file in an Amazon S3 bucket.

    • Bucket (string) -- [REQUIRED]

      The name of the S3 bucket that contains the file.

    • Key (string) -- [REQUIRED]

      The name of the file.

Returns

None

Exceptions

  • kendra.Client.exceptions.ValidationException
  • kendra.Client.exceptions.ResourceNotFoundException
  • kendra.Client.exceptions.ThrottlingException
  • kendra.Client.exceptions.AccessDeniedException
  • kendra.Client.exceptions.ConflictException
  • kendra.Client.exceptions.InternalServerException