# Ejemplos de OpenSearch Service 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 OpenSearch Service.
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-elasticsearch-domain`
En el siguiente ejemplo de código, se muestra cómo utilizar `create-elasticsearch-domain`.
**AWS CLI**
**Para crear un dominio de Amazon Elasticsearch Service**
En el siguiente comando de `create-elasticsearch-domain`, se crea un nuevo dominio de Amazon Elasticsearch Service dentro de una VPC y restringe el acceso a un único usuario. Amazon ES infiere el ID de VPC a partir de los ID de subred y grupo de seguridad especificados.
```
aws es create-elasticsearch-domain \
--domain-name vpc-cli-example \
--elasticsearch-version 6.2 \
--elasticsearch-cluster-config InstanceType=m4.large.elasticsearch,InstanceCount=1 \
--ebs-options EBSEnabled=true,VolumeType=standard,VolumeSize=10 \
--access-policies '{"Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": {"AWS": "arn:aws:iam::123456789012:root" }, "Action":"es:*", "Resource": "arn:aws:es:us-west-1:123456789012:domain/vpc-cli-example/*" } ] }' \
--vpc-options SubnetIds=subnet-1a2a3a4a,SecurityGroupIds=sg-2a3a4a5a
```
Salida:
```
{
"DomainStatus": {
"ElasticsearchClusterConfig": {
"DedicatedMasterEnabled": false,
"InstanceCount": 1,
"ZoneAwarenessEnabled": false,
"InstanceType": "m4.large.elasticsearch"
},
"DomainId": "123456789012/vpc-cli-example",
"CognitoOptions": {
"Enabled": false
},
"VPCOptions": {
"SubnetIds": [
"subnet-1a2a3a4a"
],
"VPCId": "vpc-3a4a5a6a",
"SecurityGroupIds": [
"sg-2a3a4a5a"
],
"AvailabilityZones": [
"us-west-1c"
]
},
"Created": true,
"Deleted": false,
"EBSOptions": {
"VolumeSize": 10,
"VolumeType": "standard",
"EBSEnabled": true
},
"Processing": true,
"DomainName": "vpc-cli-example",
"SnapshotOptions": {
"AutomatedSnapshotStartHour": 0
},
"ElasticsearchVersion": "6.2",
"AccessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-west-1:123456789012:domain/vpc-cli-example/*\"}]}",
"AdvancedOptions": {
"rest.action.multi.allow_explicit_index": "true"
},
"EncryptionAtRestOptions": {
"Enabled": false
},
"ARN": "arn:aws:es:us-west-1:123456789012:domain/vpc-cli-example"
}
}
```
Para obtener más información, consulte [Creating and Managing Amazon Elasticsearch Service Domains](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html) en la *Guía para desarrolladores de Amazon Elasticsearch Service*.
+ Para obtener información sobre la API, consulte [CreateElasticsearchDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/create-elasticsearch-domain.html) en la *Referencia de comandos de la AWS CLI*.
### `describe-elasticsearch-domain-config`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-elasticsearch-domain-config`.
**AWS CLI**
**Para obtener los detalles de la configuración del dominio**
En el siguiente ejemplo de `describe-elasticsearch-domain-config` se proporcionan los detalles de configuración de un dominio determinado, junto con la información del estado de cada componente de dominio individual.
```
aws es describe-elasticsearch-domain-config \
--domain-name cli-example
```
Salida:
```
{
"DomainConfig": {
"ElasticsearchVersion": {
"Options": "7.4",
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589395827.325,
"UpdateVersion": 8,
"State": "Active",
"PendingDeletion": false
}
},
"ElasticsearchClusterConfig": {
"Options": {
"InstanceType": "c5.large.elasticsearch",
"InstanceCount": 1,
"DedicatedMasterEnabled": true,
"ZoneAwarenessEnabled": false,
"DedicatedMasterType": "c5.large.elasticsearch",
"DedicatedMasterCount": 3,
"WarmEnabled": true,
"WarmType": "ultrawarm1.medium.elasticsearch",
"WarmCount": 2
},
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589395827.325,
"UpdateVersion": 8,
"State": "Active",
"PendingDeletion": false
}
},
"EBSOptions": {
"Options": {
"EBSEnabled": true,
"VolumeType": "gp2",
"VolumeSize": 10
},
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589395827.325,
"UpdateVersion": 8,
"State": "Active",
"PendingDeletion": false
}
},
"AccessPolicies": {
"Options": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"*\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/cli-example/*\"}]}",
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589395827.325,
"UpdateVersion": 8,
"State": "Active",
"PendingDeletion": false
}
},
"SnapshotOptions": {
"Options": {
"AutomatedSnapshotStartHour": 0
},
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589395827.325,
"UpdateVersion": 8,
"State": "Active",
"PendingDeletion": false
}
},
"VPCOptions": {
"Options": {},
"Status": {
"CreationDate": 1591210426.162,
"UpdateDate": 1591210426.162,
"UpdateVersion": 18,
"State": "Active",
"PendingDeletion": false
}
},
"CognitoOptions": {
"Options": {
"Enabled": false
},
"Status": {
"CreationDate": 1591210426.163,
"UpdateDate": 1591210426.163,
"UpdateVersion": 18,
"State": "Active",
"PendingDeletion": false
}
},
"EncryptionAtRestOptions": {
"Options": {
"Enabled": true,
"KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/1a2a3a4a-1a2a-1a2a-1a2a-1a2a3a4a5a6a"
},
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589395827.325,
"UpdateVersion": 8,
"State": "Active",
"PendingDeletion": false
}
},
"NodeToNodeEncryptionOptions": {
"Options": {
"Enabled": true
},
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589395827.325,
"UpdateVersion": 8,
"State": "Active",
"PendingDeletion": false
}
},
"AdvancedOptions": {
"Options": {
"rest.action.multi.allow_explicit_index": "true"
},
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589395827.325,
"UpdateVersion": 8,
"State": "Active",
"PendingDeletion": false
}
},
"LogPublishingOptions": {
"Options": {},
"Status": {
"CreationDate": 1591210426.164,
"UpdateDate": 1591210426.164,
"UpdateVersion": 18,
"State": "Active",
"PendingDeletion": false
}
},
"DomainEndpointOptions": {
"Options": {
"EnforceHTTPS": true,
"TLSSecurityPolicy": "Policy-Min-TLS-1-0-2019-07"
},
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589395827.325,
"UpdateVersion": 8,
"State": "Active",
"PendingDeletion": false
}
},
"AdvancedSecurityOptions": {
"Options": {
"Enabled": true,
"InternalUserDatabaseEnabled": true
},
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589827485.577,
"UpdateVersion": 14,
"State": "Active",
"PendingDeletion": false
}
}
}
}
```
Para obtener más información, consulte [Creating and Managing Amazon Elasticsearch Service Domains](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html) en la *Guía para desarrolladores de Amazon Elasticsearch Service*.
+ Para obtener información sobre la API, consulte [DescribeElasticsearchDomainConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/describe-elasticsearch-domain-config.html) en la *Referencia de comandos de la AWS CLI*.
### `describe-elasticsearch-domain`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-elasticsearch-domain`.
**AWS CLI**
**Para obtener los detalles para un dominio único**
En el siguiente ejemplo de `describe-elasticsearch-domain`, se proporcionan los detalles de configuración para un dominio determinado.
```
aws es describe-elasticsearch-domain \
--domain-name cli-example
```
Salida:
```
{
"DomainStatus": {
"DomainId": "123456789012/cli-example",
"DomainName": "cli-example",
"ARN": "arn:aws:es:us-east-1:123456789012:domain/cli-example",
"Created": true,
"Deleted": false,
"Endpoint": "search-cli-example-1a2a3a4a5a6a7a8a9a0a.us-east-1.es.amazonaws.com",
"Processing": false,
"UpgradeProcessing": false,
"ElasticsearchVersion": "7.4",
"ElasticsearchClusterConfig": {
"InstanceType": "c5.large.elasticsearch",
"InstanceCount": 1,
"DedicatedMasterEnabled": true,
"ZoneAwarenessEnabled": false,
"DedicatedMasterType": "c5.large.elasticsearch",
"DedicatedMasterCount": 3,
"WarmEnabled": true,
"WarmType": "ultrawarm1.medium.elasticsearch",
"WarmCount": 2
},
"EBSOptions": {
"EBSEnabled": true,
"VolumeType": "gp2",
"VolumeSize": 10
},
"AccessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"*\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/cli-example/*\"}]}",
"SnapshotOptions": {
"AutomatedSnapshotStartHour": 0
},
"CognitoOptions": {
"Enabled": false
},
"EncryptionAtRestOptions": {
"Enabled": true,
"KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/1a2a3a4a-1a2a-1a2a-1a2a-1a2a3a4a5a6a"
},
"NodeToNodeEncryptionOptions": {
"Enabled": true
},
"AdvancedOptions": {
"rest.action.multi.allow_explicit_index": "true"
},
"ServiceSoftwareOptions": {
"CurrentVersion": "R20200522",
"NewVersion": "",
"UpdateAvailable": false,
"Cancellable": false,
"UpdateStatus": "COMPLETED",
"Description": "There is no software update available for this domain.",
"AutomatedUpdateDate": 0.0
},
"DomainEndpointOptions": {
"EnforceHTTPS": true,
"TLSSecurityPolicy": "Policy-Min-TLS-1-0-2019-07"
},
"AdvancedSecurityOptions": {
"Enabled": true,
"InternalUserDatabaseEnabled": true
}
}
}
```
Para obtener más información, consulte [Creating and Managing Amazon Elasticsearch Service Domains](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html) en la *Guía para desarrolladores de Amazon Elasticsearch Service*.
+ Para obtener información sobre la API, consulte [DescribeElasticsearchDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/describe-elasticsearch-domain.html) en la *Referencia de comandos de la AWS CLI*.
### `describe-elasticsearch-domains`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-elasticsearch-domains`.
**AWS CLI**
**Para obtener los detalles para uno o más dominios**
En el siguiente ejemplo de `describe-elasticsearch-domains`, se proporcionan los detalles de configuración para uno o más dominios.
```
aws es describe-elasticsearch-domains \
--domain-names cli-example-1 cli-example-2
```
Salida:
```
{
"DomainStatusList": [{
"DomainId": "123456789012/cli-example-1",
"DomainName": "cli-example-1",
"ARN": "arn:aws:es:us-east-1:123456789012:domain/cli-example-1",
"Created": true,
"Deleted": false,
"Endpoint": "search-cli-example-1-1a2a3a4a5a6a7a8a9a0a.us-east-1.es.amazonaws.com",
"Processing": false,
"UpgradeProcessing": false,
"ElasticsearchVersion": "7.4",
"ElasticsearchClusterConfig": {
"InstanceType": "c5.large.elasticsearch",
"InstanceCount": 1,
"DedicatedMasterEnabled": true,
"ZoneAwarenessEnabled": false,
"DedicatedMasterType": "c5.large.elasticsearch",
"DedicatedMasterCount": 3,
"WarmEnabled": true,
"WarmType": "ultrawarm1.medium.elasticsearch",
"WarmCount": 2
},
"EBSOptions": {
"EBSEnabled": true,
"VolumeType": "gp2",
"VolumeSize": 10
},
"AccessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"*\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/cli-example-1/*\"}]}",
"SnapshotOptions": {
"AutomatedSnapshotStartHour": 0
},
"CognitoOptions": {
"Enabled": false
},
"EncryptionAtRestOptions": {
"Enabled": true,
"KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/1a2a3a4a-1a2a-1a2a-1a2a-1a2a3a4a5a6a"
},
"NodeToNodeEncryptionOptions": {
"Enabled": true
},
"AdvancedOptions": {
"rest.action.multi.allow_explicit_index": "true"
},
"ServiceSoftwareOptions": {
"CurrentVersion": "R20200522",
"NewVersion": "",
"UpdateAvailable": false,
"Cancellable": false,
"UpdateStatus": "COMPLETED",
"Description": "There is no software update available for this domain.",
"AutomatedUpdateDate": 0.0
},
"DomainEndpointOptions": {
"EnforceHTTPS": true,
"TLSSecurityPolicy": "Policy-Min-TLS-1-0-2019-07"
},
"AdvancedSecurityOptions": {
"Enabled": true,
"InternalUserDatabaseEnabled": true
}
},
{
"DomainId": "123456789012/cli-example-2",
"DomainName": "cli-example-2",
"ARN": "arn:aws:es:us-east-1:123456789012:domain/cli-example-2",
"Created": true,
"Deleted": false,
"Processing": true,
"UpgradeProcessing": false,
"ElasticsearchVersion": "7.4",
"ElasticsearchClusterConfig": {
"InstanceType": "r5.large.elasticsearch",
"InstanceCount": 1,
"DedicatedMasterEnabled": false,
"ZoneAwarenessEnabled": false,
"WarmEnabled": false
},
"EBSOptions": {
"EBSEnabled": true,
"VolumeType": "gp2",
"VolumeSize": 10
},
"AccessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Deny\",\"Principal\":{\"AWS\":\"*\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/cli-example-2/*\"}]}",
"SnapshotOptions": {
"AutomatedSnapshotStartHour": 0
},
"CognitoOptions": {
"Enabled": false
},
"EncryptionAtRestOptions": {
"Enabled": false
},
"NodeToNodeEncryptionOptions": {
"Enabled": false
},
"AdvancedOptions": {
"rest.action.multi.allow_explicit_index": "true"
},
"ServiceSoftwareOptions": {
"CurrentVersion": "",
"NewVersion": "",
"UpdateAvailable": false,
"Cancellable": false,
"UpdateStatus": "COMPLETED",
"Description": "There is no software update available for this domain.",
"AutomatedUpdateDate": 0.0
},
"DomainEndpointOptions": {
"EnforceHTTPS": false,
"TLSSecurityPolicy": "Policy-Min-TLS-1-0-2019-07"
},
"AdvancedSecurityOptions": {
"Enabled": false,
"InternalUserDatabaseEnabled": false
}
}
]
}
```
Para obtener más información, consulte [Creating and Managing Amazon Elasticsearch Service Domains](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html) en la *Guía para desarrolladores de Amazon Elasticsearch Service*.
+ Para obtener información sobre la API, consulte [DescribeElasticsearchDomains](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/describe-elasticsearch-domains.html) en la *Referencia de comandos de la AWS CLI*.
### `describe-reserved-elasticsearch-instances`
En el siguiente ejemplo de código, se muestra cómo utilizar `describe-reserved-elasticsearch-instances`.
**AWS CLI**
**Para ver todas las instancias reservadas**
En el siguiente ejemplo de `describe-elasticsearch-domains`, se proporciona un resumen de todas las instancias que ha reservado en una región.
```
aws es describe-reserved-elasticsearch-instances
```
Salida:
```
{
"ReservedElasticsearchInstances": [{
"FixedPrice": 100.0,
"ReservedElasticsearchInstanceOfferingId": "1a2a3a4a5-1a2a-3a4a-5a6a-1a2a3a4a5a6a",
"ReservationName": "my-reservation",
"PaymentOption": "PARTIAL_UPFRONT",
"UsagePrice": 0.0,
"ReservedElasticsearchInstanceId": "9a8a7a6a-5a4a-3a2a-1a0a-9a8a7a6a5a4a",
"RecurringCharges": [{
"RecurringChargeAmount": 0.603,
"RecurringChargeFrequency": "Hourly"
}],
"State": "payment-pending",
"StartTime": 1522872571.229,
"ElasticsearchInstanceCount": 3,
"Duration": 31536000,
"ElasticsearchInstanceType": "m4.2xlarge.elasticsearch",
"CurrencyCode": "USD"
}]
}
```
Para obtener más información, consulte [Reserved Instances](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/aes-ri.html) en la *Guía para desarrolladores de Amazon Elasticsearch Service*.
+ Para obtener información sobre la API, consulte [DescribeReservedElasticsearchInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/describe-reserved-elasticsearch-instances.html) en la *Referencia de comandos de la AWS CLI*.
### `list-domain-names`
En el siguiente ejemplo de código, se muestra cómo utilizar `list-domain-names`.
**AWS CLI**
**Para enumerar todos los dominios**
En el siguiente ejemplo de `list-domain-names` se proporciona un resumen rápido de todos los dominios de la región.
```
aws es list-domain-names
```
Salida:
```
{
"DomainNames": [{
"DomainName": "cli-example-1"
},
{
"DomainName": "cli-example-2"
}
]
}
```
Para obtener más información, consulte [Creating and Managing Amazon Elasticsearch Service Domains](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html) en la *Guía para desarrolladores de Amazon Elasticsearch Service*.
+ Para obtener información sobre la API, consulte [ListDomainNames](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/list-domain-names.html) en la *Referencia de comandos de la AWS CLI*.