| Column Name | Column Data Type |
|---|
id Required Input Column
The identifier of the index. | VARCHAR |
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
Show child fields- _aws_profile.account_id
The AWS account id - _aws_profile.assumed_role_arn
The ARN of the assumed role - _aws_profile.name
The unique name of the profile. - _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization - _aws_profile.organization.id
The organization id - _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address - _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent - _aws_profile.organization.parents[].name
The name of the parent - _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role' - _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
_aws_region Input Column
The AWS region to use. | VARCHAR |
capacity_units
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. | STRUCT(
"storage_capacity_units" BIGINT,
"query_capacity_units" BIGINT
) |
Show child fields- capacity_units.query_capacity_units
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). - capacity_units.storage_capacity_units
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.
|
created_at
The Unix timestamp when the index was created. | TIMESTAMP_S |
description
The description for the index. | VARCHAR |
document_metadata_configurations
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. | STRUCT(
"name" VARCHAR,
"type" VARCHAR,
"relevance" STRUCT(
"freshness" BOOLEAN,
"importance" BIGINT,
"duration" VARCHAR,
"rank_order" VARCHAR,
"value_importance_map" MAP(VARCHAR, BIGINT)
),
"search" STRUCT(
"facetable" BOOLEAN,
"searchable" BOOLEAN,
"displayable" BOOLEAN,
"sortable" BOOLEAN
)
)[] |
Show child fields- document_metadata_configurations[]
Show child fields- document_metadata_configurations[].name
The name of the index field. - document_metadata_configurations[].relevance
Provides tuning parameters to determine how the field affects the search results. Show child fields- document_metadata_configurations[].relevance.duration
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. - document_metadata_configurations[].relevance.freshness
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. - document_metadata_configurations[].relevance.importance
The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers. - document_metadata_configurations[].relevance.rank_order
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. - document_metadata_configurations[].relevance.value_importance_map
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.
- document_metadata_configurations[].search
Provides information about how the field is used during a search. Show child fields- document_metadata_configurations[].search.displayable
Determines whether the field is returned in the query response. The default is true. - document_metadata_configurations[].search.facetable
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 . - document_metadata_configurations[].search.searchable
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. - document_metadata_configurations[].search.sortable
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.
- document_metadata_configurations[].type
The data type of the index field.
|
edition
The Amazon Kendra edition used for the index. You decide the edition when you create the index. | VARCHAR |
error_message
When the Status field value is FAILED, the ErrorMessage field contains a message that explains why. | VARCHAR |
index_statistics
Provides information about the number of FAQ questions and answers and the number of text documents indexed. | STRUCT(
"faq_statistics" STRUCT(
"indexed_question_answers_count" BIGINT
),
"text_document_statistics" STRUCT(
"indexed_text_documents_count" BIGINT,
"indexed_text_bytes" BIGINT
)
) |
Show child fields- index_statistics.faq_statistics
The number of question and answer topics in the index. Show child fields- index_statistics.faq_statistics.indexed_question_answers_count
The total number of FAQ questions and answers contained in the index.
- index_statistics.text_document_statistics
The number of text documents indexed. Show child fields- index_statistics.text_document_statistics.indexed_text_bytes
The total size, in bytes, of the indexed documents. - index_statistics.text_document_statistics.indexed_text_documents_count
The number of text documents indexed.
|
name
The name of the index. | VARCHAR |
role_arn
The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon CloudWatch logs. | VARCHAR |
server_side_encryption_configuration
The identifier of the KMS customer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs. | STRUCT(
"kms_key_id" VARCHAR
) |
Show child fields- server_side_encryption_configuration.kms_key_id
The identifier of the KMS key. Amazon Kendra doesn't support asymmetric keys.
|
status
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. | VARCHAR |
updated_at
The Unix timestamp when the index was last updated. | TIMESTAMP_S |
user_context_policy
The user context policy for the Amazon Kendra index. | VARCHAR |
user_group_resolution_configuration
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. | STRUCT(
"user_group_resolution_mode" VARCHAR
) |
Show child fields- user_group_resolution_configuration.user_group_resolution_mode
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.
|
user_token_configurations
The user token configuration for the Amazon Kendra index. | STRUCT(
"jwt_token_type_configuration" STRUCT(
"key_location" VARCHAR,
"url" VARCHAR,
"secret_manager_arn" VARCHAR,
"user_name_attribute_field" VARCHAR,
"group_attribute_field" VARCHAR,
"issuer" VARCHAR,
"claim_regex" VARCHAR
),
"json_token_type_configuration" STRUCT(
"user_name_attribute_field" VARCHAR,
"group_attribute_field" VARCHAR
)
)[] |
Show child fields- user_token_configurations[]
Show child fields- user_token_configurations[].json_token_type_configuration
Information about the JSON token type configuration. Show child fields- user_token_configurations[].json_token_type_configuration.group_attribute_field
The group attribute field. - user_token_configurations[].json_token_type_configuration.user_name_attribute_field
The user name attribute field.
- user_token_configurations[].jwt_token_type_configuration
Information about the JWT token type configuration. Show child fields- user_token_configurations[].jwt_token_type_configuration.claim_regex
The regular expression that identifies the claim. - user_token_configurations[].jwt_token_type_configuration.group_attribute_field
The group attribute field. - user_token_configurations[].jwt_token_type_configuration.issuer
The issuer of the token. - user_token_configurations[].jwt_token_type_configuration.key_location
The location of the key. - user_token_configurations[].jwt_token_type_configuration.secret_manager_arn
The Amazon Resource Name (arn) of the secret. - user_token_configurations[].jwt_token_type_configuration.url
The signing key URL. - user_token_configurations[].jwt_token_type_configuration.user_name_attribute_field
The user name attribute field.
|