QBusiness / Client / get_index

get_index#

QBusiness.Client.get_index(**kwargs)#

Gets information about an existing Amazon Q Business 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 Business application connected to the index.

  • indexId (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • applicationId (string) –

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

    • indexId (string) –

      The identifier of the Amazon Q Business index.

    • displayName (string) –

      The name of the Amazon Q Business index.

    • indexArn (string) –

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

    • 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.

    • type (string) –

      The type of index attached to your Amazon Q Business application.

    • description (string) –

      The description for the Amazon Q Business index.

    • createdAt (datetime) –

      The Unix timestamp when the Amazon Q Business index was created.

    • updatedAt (datetime) –

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

    • capacityConfiguration (dict) –

      The storage capacity units chosen for your Amazon Q Business index.

      • units (integer) –

        The number of storage units configured for an Amazon Q Business 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.

        • type (string) –

          The type of 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.

    • error (dict) –

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

      • errorMessage (string) –

        The message explaining the Amazon Q Business request error.

      • errorCode (string) –

        The code associated with the Amazon Q Business request error.

    • 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.

Exceptions