kendra / Client / describe_index

describe_index#

kendra.Client.describe_index(**kwargs)#

Gets information about an Amazon Kendra index.

Request Syntax

response = client.describe_index(
    Id='string'
)

Parameters:

Id (string) –

[REQUIRED]

The identifier of the index you want to get information on.

Return type:

dict

Returns:

Response Syntax

{
    'Name': 'string',
    'Id': 'string',
    'Edition': 'DEVELOPER_EDITION'|'ENTERPRISE_EDITION'|'GEN_AI_ENTERPRISE_EDITION',
    'RoleArn': 'string',
    'ServerSideEncryptionConfiguration': {
        'KmsKeyId': 'string'
    },
    'Status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING'|'SYSTEM_UPDATING',
    'Description': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'UpdatedAt': datetime(2015, 1, 1),
    'DocumentMetadataConfigurations': [
        {
            'Name': 'string',
            'Type': 'STRING_VALUE'|'STRING_LIST_VALUE'|'LONG_VALUE'|'DATE_VALUE',
            'Relevance': {
                'Freshness': True|False,
                'Importance': 123,
                'Duration': 'string',
                'RankOrder': 'ASCENDING'|'DESCENDING',
                'ValueImportanceMap': {
                    'string': 123
                }
            },
            'Search': {
                'Facetable': True|False,
                'Searchable': True|False,
                'Displayable': True|False,
                'Sortable': True|False
            }
        },
    ],
    'IndexStatistics': {
        'FaqStatistics': {
            'IndexedQuestionAnswersCount': 123
        },
        'TextDocumentStatistics': {
            'IndexedTextDocumentsCount': 123,
            'IndexedTextBytes': 123
        }
    },
    'ErrorMessage': 'string',
    'CapacityUnits': {
        'StorageCapacityUnits': 123,
        'QueryCapacityUnits': 123
    },
    'UserTokenConfigurations': [
        {
            'JwtTokenTypeConfiguration': {
                'KeyLocation': 'URL'|'SECRET_MANAGER',
                'URL': 'string',
                'SecretManagerArn': 'string',
                'UserNameAttributeField': 'string',
                'GroupAttributeField': 'string',
                'Issuer': 'string',
                'ClaimRegex': 'string'
            },
            'JsonTokenTypeConfiguration': {
                'UserNameAttributeField': 'string',
                'GroupAttributeField': 'string'
            }
        },
    ],
    'UserContextPolicy': 'ATTRIBUTE_FILTER'|'USER_TOKEN',
    'UserGroupResolutionConfiguration': {
        'UserGroupResolutionMode': 'AWS_SSO'|'NONE'
    }
}

Response Structure

(dict) –
- Name (string) –
  
  The name of the index.
- Id (string) –
  
  The identifier of the index.
- Edition (string) –
  
  The Amazon Kendra edition used for the index. You decide the edition when you create the index.
- RoleArn (string) –
  
  The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon CloudWatch logs.
- ServerSideEncryptionConfiguration (dict) –
  
  The identifier of the KMS customer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn’t support asymmetric CMKs.
  - KmsKeyId (string) –
    
    The identifier of the KMS key. Amazon Kendra doesn’t support asymmetric keys.
- 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.
- Description (string) –
  
  The description for the index.
- CreatedAt (datetime) –
  
  The Unix timestamp when the index was created.
- UpdatedAt (datetime) –
  
  The Unix timestamp when the index was last updated.
- DocumentMetadataConfigurations (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.
  - (dict) –
    
    Specifies the properties, such as relevance tuning and searchability, of an index field.
    - Name (string) –
      
      The name of the index field.
    - Type (string) –
      
      The data type of the index field.
    - Relevance (dict) –
      
      Provides tuning parameters to determine how the field affects the search results.
      - Freshness (boolean) –
        
        Indicates that this field determines how “fresh” a document is. For example, if document 1 was created on November 5, and document 2 was created on October 31, document 1 is “fresher” than document 2. Only applies to DATE fields.
      - Importance (integer) –
        
        The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers.
      - Duration (string) –
        
        Specifies the time period that the boost applies to. For example, to make the boost apply to documents with the field value within the last month, you would use “2628000s”. Once the field value is beyond the specified range, the effect of the boost drops off. The higher the importance, the faster the effect drops off. If you don’t specify a value, the default is 3 months. The value of the field is a numeric string followed by the character “s”, for example “86400s” for one day, or “604800s” for one week.
        
        Only applies to DATE fields.
      - RankOrder (string) –
        
        Determines how values should be interpreted.
        
        When the RankOrder field is ASCENDING, higher numbers are better. For example, a document with a rating score of 10 is higher ranking than a document with a rating score of 1.
        
        When the RankOrder field is DESCENDING, lower numbers are better. For example, in a task tracking application, a priority 1 task is more important than a priority 5 task.
        
        Only applies to LONG fields.
      - ValueImportanceMap (dict) –
        
        A list of values that should be given a different boost when they appear in the result list. For example, if you are boosting a field called “department”, query terms that match the department field are boosted in the result. However, you can add entries from the department field to boost documents with those values higher.
        
        For example, you can add entries to the map with names of departments. If you add “HR”,5 and “Legal”,3 those departments are given special attention when they appear in the metadata of a document. When those terms appear they are given the specified importance instead of the regular importance for the boost.
        
        (string) –
        
        (integer) –
    - Search (dict) –
      
      Provides information about how the field is used during a search.
      - Facetable (boolean) –
        
        Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is false .
      - Searchable (boolean) –
        
        Determines whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.
      - Displayable (boolean) –
        
        Determines whether the field is returned in the query response. The default is true.
      - Sortable (boolean) –
        
        Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.
- IndexStatistics (dict) –
  
  Provides information about the number of FAQ questions and answers and the number of text documents indexed.
  - FaqStatistics (dict) –
    
    The number of question and answer topics in the index.
    - IndexedQuestionAnswersCount (integer) –
      
      The total number of FAQ questions and answers for an index.
  - TextDocumentStatistics (dict) –
    
    The number of text documents indexed.
    - IndexedTextDocumentsCount (integer) –
      
      The number of text documents indexed.
    - IndexedTextBytes (integer) –
      
      The total size, in bytes, of the indexed documents.
- ErrorMessage (string) –
  
  When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
- CapacityUnits (dict) –
  
  For Enterprise Edition indexes, you can choose to use additional capacity to meet the needs of your application. This contains the capacity units used for the index. A query or document storage capacity of zero indicates that the index is using the default capacity. For more information on the default capacity for an index and adjusting this, see Adjusting capacity.
  - StorageCapacityUnits (integer) –
    
    The amount of extra storage capacity for an index. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first. You can add up to 100 extra capacity units.
  - QueryCapacityUnits (integer) –
    
    The amount of extra query capacity for an index and GetQuerySuggestions capacity.
    
    A single extra capacity unit for an index provides 0.1 queries per second or approximately 8,000 queries per day. You can add up to 100 extra capacity units.
    
    GetQuerySuggestions capacity is five times the provisioned query capacity for an index, or the base capacity of 2.5 calls per second, whichever is higher. For example, the base capacity for an index is 0.1 queries per second, and GetQuerySuggestions capacity has a base of 2.5 calls per second. If you add another 0.1 queries per second to total 0.2 queries per second for an index, the GetQuerySuggestions capacity is 2.5 calls per second (higher than five times 0.2 queries per second).
- UserTokenConfigurations (list) –
  
  The user token configuration for the Amazon Kendra index.
  - (dict) –
    
    Provides the configuration information for a token.
    
    Warning
    If you’re using an Amazon Kendra Gen AI Enterprise Edition index and you try to use UserTokenConfigurations to configure user context policy, Amazon Kendra returns a ValidationException error.
    - JwtTokenTypeConfiguration (dict) –
      
      Information about the JWT token type configuration.
      - KeyLocation (string) –
        
        The location of the key.
      - URL (string) –
        
        The signing key URL.
      - SecretManagerArn (string) –
        
        The Amazon Resource Name (arn) of the secret.
      - UserNameAttributeField (string) –
        
        The user name attribute field.
      - GroupAttributeField (string) –
        
        The group attribute field.
      - Issuer (string) –
        
        The issuer of the token.
      - ClaimRegex (string) –
        
        The regular expression that identifies the claim.
    - JsonTokenTypeConfiguration (dict) –
      
      Information about the JSON token type configuration.
      - UserNameAttributeField (string) –
        
        The user name attribute field.
      - GroupAttributeField (string) –
        
        The group attribute field.
- UserContextPolicy (string) –
  
  The user context policy for the Amazon Kendra index.
- UserGroupResolutionConfiguration (dict) –
  
  Whether you have enabled IAM Identity Center identity source for your users and groups. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
  - UserGroupResolutionMode (string) –
    
    The identity store provider (mode) you want to use to get users and groups. IAM Identity Center is currently the only available mode. Your users and groups must exist in an IAM Identity Center identity source in order to use this mode.

Exceptions

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