aws_qbusiness_index

account_id

Type: STRING

application_id

Type: STRING
Provider name: applicationId
Description: The identifier of the Amazon Q Business application associated with the index.

capacity_configuration

Type: STRUCT
Provider name: capacityConfiguration
Description: The storage capacity units chosen for your Amazon Q Business index.

• units
  Type: INT32
  Provider name: units
  Description: The number of storage units configured for an Amazon Q Business index.
  

created_at

Type: TIMESTAMP
Provider name: createdAt
Description: The Unix timestamp when the Amazon Q Business index was created.

description

Type: STRING
Provider name: description
Description: The description for the Amazon Q Business index.

document_attribute_configurations

Type: UNORDERED_LIST_STRUCT
Provider name: documentAttributeConfigurations
Description: 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.

• name
  Type: STRING
  Provider name: name
  Description: The name of the document attribute.
  
• search
  Type: STRING
  Provider name: search
  Description: Information about whether the document attribute can be used by an end user to search for information on their web experience.
  
• type
  Type: STRING
  Provider name: type
  Description: The type of document attribute.
  

error

Type: STRUCT
Provider name: error
Description: When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

• error_code
  Type: STRING
  Provider name: errorCode
  Description: The code associated with the Amazon Q Business request error.
  
• error_message
  Type: STRING
  Provider name: errorMessage
  Description: The message explaining the Amazon Q Business request error.
  

index_arn

Type: STRING
Provider name: indexArn
Description: The Amazon Resource Name (ARN) of the Amazon Q Business index.

index_id

Type: STRING
Provider name: indexId
Description: The identifier of the Amazon Q Business index.

index_statistics

Type: STRUCT
Provider name: indexStatistics
Description: Provides information about the number of documents indexed.

• text_document_statistics
  Type: STRUCT
  Provider name: textDocumentStatistics
  Description: The number of documents indexed.
  
  • indexed_text_bytes
    Type: INT64
    Provider name: indexedTextBytes
    Description: The total size, in bytes, of the indexed documents.
    
  • indexed_text_document_count
    Type: INT32
    Provider name: indexedTextDocumentCount
    Description: The number of text documents indexed.
    

status

Type: STRING
Provider name: status
Description: 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.

tags

Type: UNORDERED_LIST_STRING

type

Type: STRING
Provider name: type
Description: The type of index attached to your Amazon Q Business application.

updated_at

Type: TIMESTAMP
Provider name: updatedAt
Description: The Unix timestamp when the Amazon Q Business index was last updated.