# Ejemplos de Amazon Kendra que utilizan la AWS CLI
En los siguientes ejemplos de código se muestra cómo realizar acciones e implementar escenarios comunes usando AWS Command Line Interface con Amazon Kendra.
Las *acciones* son extractos de código de programas más grandes y deben ejecutarse en contexto. Mientras las acciones muestran cómo llamar a las distintas funciones de servicio, es posible ver las acciones en contexto en los escenarios relacionados.
En cada ejemplo se incluye un enlace al código de origen completo, con instrucciones de configuración y ejecución del código en el contexto.
**Topics**
+ [Acciones](#actions)
## Acciones
### `create-data-source`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-data-source`.
**AWS CLI**
**Para crear un conector de origen de datos de Amazon Kendra**
En el siguiente ejemplo de `create-data-source`, se crea y configura un conector de origen de datos de Amazon Kendra. Puede utilizar `describe-data-source` para ver el estado de un conector de origen de datos y leer cualquier mensaje de error si el estado indica que un conector de origen de datos no se ha podido crear por completo (FAILED).
```
aws kendra create-data-source \
--name "example data source 1" \
--description "Example data source 1 for example index 1 contains the first set of example documents" \
--tags '{"Key": "test resources", "Value": "kendra"}, {"Key": "test resources", "Value": "aws"}' \
--role-arn "arn:aws:iam::my-account-id:role/KendraRoleForS3TemplateConfigDataSource" \
--index-id exampleindex1 \
--language-code "es" \
--schedule "0 0 18 ? * TUE,MON,WED,THU,FRI,SAT *" \
--configuration '{"TemplateConfiguration": {"Template": file://s3schemaconfig.json}}' \
--type "TEMPLATE" \
--custom-document-enrichment-configuration '{"PostExtractionHookConfiguration": {"LambdaArn": "arn:aws:iam::my-account-id:function/my-function-ocr-docs", "S3Bucket": "s3://amzn-s3-demo-bucket/scanned-image-text-example-docs"}, "RoleArn": "arn:aws:iam:my-account-id:role/KendraRoleForCDE"}' \
--vpc-configuration '{"SecurityGroupIds": ["sg-1234567890abcdef0"], "SubnetIds": ["subnet-1c234","subnet-2b134"]}'
```
Salida:
```
{
"Id": "exampledatasource1"
}
```
Para obtener más información, consulte [Getting started with an Amazon Kendra index and data source connector](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html) en la *Guía para desarrolladores de Amazon Kendra*.
+ Para obtener información sobre la API, consulte [CreateDataSource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/create-data-source.html) en la *Referencia de comandos de la AWS CLI*.
### `create-index`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-index`.
**AWS CLI**
**Para crear un índice de Amazon Kendra**
En el siguiente ejemplo de `create-index`, se crea y configura un índice de Amazon Kendra. Puede utilizar `describe-index` para ver el estado de un índice y leer cualquier mensaje de error si el estado muestra un índice que ha fallado (FAILED) al crearse completamente.
```
aws kendra create-index \
--name "example index 1" \
--description "Example index 1 contains the first set of example documents" \
--tags '{"Key": "test resources", "Value": "kendra"}, {"Key": "test resources", "Value": "aws"}' \
--role-arn "arn:aws:iam::my-account-id:role/KendraRoleForExampleIndex" \
--edition "DEVELOPER_EDITION" \
--server-side-encryption-configuration '{"KmsKeyId": "my-kms-key-id"}' \
--user-context-policy "USER_TOKEN" \
--user-token-configurations '{"JsonTokenTypeConfiguration": {"GroupAttributeField": "groupNameField", "UserNameAttributeField": "userNameField"}}'
```
Salida:
```
{
"Id": index1
}
```
Para obtener más información, consulte [Getting started with an Amazon Kendra index and data source connector](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html) en la *Guía para desarrolladores de Amazon Kendra*.
+ Para obtener información sobre la API, consulte [CreateIndex](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/create-index.html) en la *Referencia de comandos de la AWS CLI*.
### `describe-data-source`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-data-source`.
**AWS CLI**
**Para obtener información sobre un conector de origen de datos de Amazon Kendra**
En el siguiente ejemplo de `describe-data-source`, se obtiene información sobre un conector de origen de datos de Amazon Kendra. Puede ver la configuración de un conector de origen de datos y leer cualquier mensaje de error si el estado indica que un conector de origen de datos no se ha podido crear por completo (FAILED).
```
aws kendra describe-data-source \
--id exampledatasource1 \
--index-id exampleindex1
```
Salida:
```
{
"Configuration": {
"TemplateConfiguration": {
"Template": {
"connectionConfiguration": {
"repositoryEndpointMetadata": {
"BucketName": "amzn-s3-demo-bucket"
}
},
"repositoryConfigurations": {
"document":{
"fieldMappings": [
{
"indexFieldName":"_document_title",
"indexFieldType":"STRING",
"dataSourceFieldName": "title"
},
{
"indexFieldName":"_last_updated_at",
"indexFieldType":"DATE",
"dataSourceFieldName": "modified_date"
}
]
}
},
"additionalProperties": {
"inclusionPatterns": [
"*.txt",
"*.doc",
"*.docx"
],
"exclusionPatterns": [
"*.json"
],
"inclusionPrefixes": [
"PublicExampleDocsFolder"
],
"exclusionPrefixes": [
"PrivateDocsFolder/private"
],
"aclConfigurationFilePath": "ExampleDocsFolder/AclConfig.json",
"metadataFilesPrefix": "metadata"
},
"syncMode": "FULL_CRAWL",
"type" : "S3",
"version": "1.0.0"
}
}
},
"CreatedAt": 2024-02-25T13:30:10+00:00,
"CustomDocumentEnrichmentConfiguration": {
"PostExtractionHookConfiguration": {
"LambdaArn": "arn:aws:iam::my-account-id:function/my-function-ocr-docs",
"S3Bucket": "s3://amzn-s3-demo-bucket/scanned-image-text-example-docs/function"
},
"RoleArn": "arn:aws:iam:my-account-id:role/KendraRoleForCDE"
}
"Description": "Example data source 1 for example index 1 contains the first set of example documents",
"Id": exampledatasource1,
"IndexId": exampleindex1,
"LanguageCode": "en",
"Name": "example data source 1",
"RoleArn": "arn:aws:iam::my-account-id:role/KendraRoleForS3TemplateConfigDataSource",
"Schedule": "0 0 18 ? * TUE,MON,WED,THU,FRI,SAT *",
"Status": "ACTIVE",
"Type": "TEMPLATE",
"UpdatedAt": 1709163615,
"VpcConfiguration": {
"SecurityGroupIds": ["sg-1234567890abcdef0"],
"SubnetIds": ["subnet-1c234","subnet-2b134"]
}
}
```
Para obtener más información, consulte [Getting started with an Amazon Kendra index and data source connector](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html) en la *Guía para desarrolladores de Amazon Kendra*.
+ Para obtener información sobre la API, consulte [DescribeDataSource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/describe-data-source.html) en la *Referencia de comandos de la AWS CLI*.
### `describe-index`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-index`.
**AWS CLI**
**Para obtener información sobre un índice de Amazon Kendra**
En el siguiente ejemplo de `describe-index`, se obtiene información sobre un índice de Amazon Kendra. Puede ver la configuración de un índice y leer cualquier mensaje de error si el estado indica que el índice no se ha podido crear por completo (FAILED).
```
aws kendra describe-index \
--id exampleindex1
```
Salida:
```
{
"CapacityUnits": {
"QueryCapacityUnits": 0,
"StorageCapacityUnits": 0
},
"CreatedAt": 2024-02-25T12:30:10+00:00,
"Description": "Example index 1 contains the first set of example documents",
"DocumentMetadataConfigurations": [
{
"Name": "_document_title",
"Relevance": {
"Importance": 8
},
"Search": {
"Displayable": true,
"Facetable": false,
"Searchable": true,
"Sortable": false
},
"Type": "STRING_VALUE"
},
{
"Name": "_document_body",
"Relevance": {
"Importance": 5
},
"Search": {
"Displayable": true,
"Facetable": false,
"Searchable": true,
"Sortable": false
},
"Type": "STRING_VALUE"
},
{
"Name": "_last_updated_at",
"Relevance": {
"Importance": 6,
"Duration": "2628000s",
"Freshness": true
},
"Search": {
"Displayable": true,
"Facetable": false,
"Searchable": true,
"Sortable": true
},
"Type": "DATE_VALUE"
},
{
"Name": "department_custom_field",
"Relevance": {
"Importance": 7,
"ValueImportanceMap": {
"Human Resources" : 4,
"Marketing and Sales" : 2,
"Research and innvoation" : 3,
"Admin" : 1
}
},
"Search": {
"Displayable": true,
"Facetable": true,
"Searchable": true,
"Sortable": true
},
"Type": "STRING_VALUE"
}
],
"Edition": "DEVELOPER_EDITION",
"Id": "index1",
"IndexStatistics": {
"FaqStatistics": {
"IndexedQuestionAnswersCount": 10
},
"TextDocumentStatistics": {
"IndexedTextBytes": 1073741824,
"IndexedTextDocumentsCount": 1200
}
},
"Name": "example index 1",
"RoleArn": "arn:aws:iam::my-account-id:role/KendraRoleForExampleIndex",
"ServerSideEncryptionConfiguration": {
"KmsKeyId": "my-kms-key-id"
},
"Status": "ACTIVE",
"UpdatedAt": 1709163615,
"UserContextPolicy": "USER_TOKEN",
"UserTokenConfigurations": [
{
"JsonTokenTypeConfiguration": {
"GroupAttributeField": "groupNameField",
"UserNameAttributeField": "userNameField"
}
}
]
}
```
Para obtener más información, consulte [Getting started with an Amazon Kendra index and data source connector](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html) en la *Guía para desarrolladores de Amazon Kendra*.
+ Para obtener información sobre la API, consulte [DescribeIndex](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/describe-index.html) en la *Referencia de comandos de la AWS CLI*.
### `update-data-source`
En el siguiente ejemplo de código, se muestra cómo utilizar `update-data-source`.
**AWS CLI**
**Para actualizar un conector de origen de datos de Amazon Kendra**
En el siguiente ejemplo de `update-data-source`, se actualiza la configuración de un conector de origen de datos de Amazon Kendra. Si la acción se realiza correctamente, el servicio no devuelve ningún resultado, el código de estado HTTP 200 o el código de retorno de AWS CLI 0. Se puede utilizar `describe-data-source` para ver la configuración y el estado de un conector de origen de datos.
```
aws kendra update-data-source \
--id exampledatasource1 \
--index-id exampleindex1 \
--name "new name for example data source 1" \
--description "new description for example data source 1" \
--role-arn arn:aws:iam::my-account-id:role/KendraNewRoleForExampleDataSource \
--configuration '{"TemplateConfiguration": {"Template": file://s3schemanewconfig.json}}' \
--custom-document-enrichment-configuration '{"PostExtractionHookConfiguration": {"LambdaArn": "arn:aws:iam::my-account-id:function/my-function-ocr-docs", "S3Bucket": "s3://amzn-s3-demo-bucket/scanned-image-text-example-docs"}, "RoleArn": "arn:aws:iam:my-account-id:role/KendraNewRoleForCDE"}' \
--language-code "es" \
--schedule "0 0 18 ? * MON,WED,FRI *" \
--vpc-configuration '{"SecurityGroupIds": ["sg-1234567890abcdef0"], "SubnetIds": ["subnet-1c234","subnet-2b134"]}'
```
Este comando no genera ninguna salida.
Para obtener más información, consulte [Getting started with an Amazon Kendra index and data source connector](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html) en la *Guía para desarrolladores de Amazon Kendra*.
+ Para obtener información sobre la API, consulte [UpdateDataSource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/update-data-source.html) en la *Referencia de comandos de la AWS CLI*.
### `update-index`
En el siguiente ejemplo de código, se muestra cómo utilizar `update-index`.
**AWS CLI**
**Para actualizar un índice de Amazon Kendra**
En el siguiente ejemplo de `update-index`, se actualiza la configuración de un índice de Amazon Kendra. Si la acción se realiza correctamente, el servicio no devuelve ningún resultado, el código de estado HTTP 200 o el código de retorno de AWS CLI 0. Se puede utilizar `describe-index` para ver la configuración y el estado de un índice.
```
aws kendra update-index \
--id enterpriseindex1 \
--name "new name for Enterprise Edition index 1" \
--description "new description for Enterprise Edition index 1" \
--role-arn arn:aws:iam::my-account-id:role/KendraNewRoleForEnterpriseIndex \
--capacity-units '{"QueryCapacityUnits": 2, "StorageCapacityUnits": 1}' \
--document-metadata-configuration-updates '{"Name": "_document_title", "Relevance": {"Importance": 6}}, {"Name": "_last_updated_at", "Relevance": {"Importance": 8}}' \
--user-context-policy "USER_TOKEN" \
--user-token-configurations '{"JsonTokenTypeConfiguration": {"GroupAttributeField": "groupNameField", "UserNameAttributeField": "userNameField"}}'
```
Este comando no genera ninguna salida.
Para obtener más información, consulte [Getting started with an Amazon Kendra index and data source connector](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html) en la *Guía para desarrolladores de Amazon Kendra*.
+ Para obtener información sobre la API, consulte [UpdateIndex](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/update-index.html) en la *Referencia de comandos de la AWS CLI*.