QBusiness / Client / update_index

update_index#

QBusiness.Client.update_index(**kwargs)#

Updates an Amazon Q index.

See also: AWS API Documentation

Request Syntax

response = client.update_index(
    applicationId='string',
    capacityConfiguration={
        'units': 123
    },
    description='string',
    displayName='string',
    documentAttributeConfigurations=[
        {
            'name': 'string',
            'search': 'ENABLED'|'DISABLED',
            'type': 'STRING'|'STRING_LIST'|'NUMBER'|'DATE'
        },
    ],
    indexId='string'
)
Parameters:

  • applicationId (string) –

    [REQUIRED]

    The identifier of the Amazon Q application connected to the index.

  • capacityConfiguration (dict) –

    The storage capacity units you want to provision for your Amazon Q index. You can add and remove capacity to fit your usage needs.

    • units (integer) –

      The number of storage units configured for an Amazon Q index.

  • description (string) – The description of the Amazon Q index.

  • displayName (string) – The name of the Amazon Q index.

  • documentAttributeConfigurations (list) –

    Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

    • (dict) –

      Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

      For more information, see Understanding document attributes.

      • name (string) –

        The name of the document attribute.

      • search (string) –

        Information about whether the document attribute can be used by an end user to search for information on their web experience.

      • type (string) –

        The type of document attribute.

  • indexId (string) –

    [REQUIRED]

    The identifier of the Amazon Q index.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • QBusiness.Client.exceptions.ResourceNotFoundException

  • QBusiness.Client.exceptions.InternalServerException

  • QBusiness.Client.exceptions.ConflictException

  • QBusiness.Client.exceptions.ThrottlingException

  • QBusiness.Client.exceptions.ValidationException

  • QBusiness.Client.exceptions.AccessDeniedException

  • QBusiness.Client.exceptions.ServiceQuotaExceededException