QBusiness / Client / get_index

get_index

QBusiness.Client.get_index(**kwargs)

Gets information about an existing Amazon Q index.

See also: AWS API Documentation

Request Syntax

response = client.get_index(
    applicationId='string',
    indexId='string'
)

Parameters:

• applicationId (string) –

  [REQUIRED]

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

• indexId (string) –

  [REQUIRED]

  The identifier of the Amazon Q index you want information on.

Return type:

dict

Returns:

Response Syntax

{
    'applicationId': 'string',
    'capacityConfiguration': {
        'units': 123
    },
    'createdAt': datetime(2015, 1, 1),
    'description': 'string',
    'displayName': 'string',
    'documentAttributeConfigurations': [
        {
            'name': 'string',
            'search': 'ENABLED'|'DISABLED',
            'type': 'STRING'|'STRING_LIST'|'NUMBER'|'DATE'
        },
    ],
    'error': {
        'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound',
        'errorMessage': 'string'
    },
    'indexArn': 'string',
    'indexId': 'string',
    'indexStatistics': {
        'textDocumentStatistics': {
            'indexedTextBytes': 123,
            'indexedTextDocumentCount': 123
        }
    },
    'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • applicationId (string) –

    The identifier of the Amazon Q application associated with the index.

  • capacityConfiguration (dict) –

    The storage capacity units chosen for your Amazon Q index.

    • units (integer) –

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

  • createdAt (datetime) –

    The Unix timestamp when the Amazon Q index was created.

  • description (string) –

    The description for the Amazon Q index.

  • displayName (string) –

    The name of the Amazon Q index.

  • documentAttributeConfigurations (list) –

    Configuration information for document attributes or metadata. Document metadata are fields 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.

  • error (dict) –

    When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

    • errorCode (string) –

      The code associated with the data source sync error.

    • errorMessage (string) –

      The message explaining the data source sync error.

  • indexArn (string) –

    The Amazon Resource Name (ARN) of the Amazon Q index.

  • indexId (string) –

    The identifier of the Amazon Q index.

  • indexStatistics (dict) –

    Provides information about the number of documents indexed.

    • textDocumentStatistics (dict) –

      The number of documents indexed.

      • indexedTextBytes (integer) –

        The total size, in bytes, of the indexed documents.

      • indexedTextDocumentCount (integer) –

        The number of text documents indexed.

  • status (string) –

    The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

  • updatedAt (datetime) –

    The Unix timestamp when the Amazon Q index was last updated.

Exceptions

• QBusiness.Client.exceptions.ResourceNotFoundException

• QBusiness.Client.exceptions.InternalServerException

• QBusiness.Client.exceptions.ThrottlingException

• QBusiness.Client.exceptions.ValidationException

• QBusiness.Client.exceptions.AccessDeniedException