# Exemplos do OpenSearch Service usando o AWS CLI
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o OpenSearch Service.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `create-elasticsearch-domain`
O código de exemplo a seguir mostra como usar `create-elasticsearch-domain`.
**AWS CLI**
**Criar um domínio do Amazon Elasticsearch Service**
O comando `create-elasticsearch-domain` a seguir cria um novo domínio do Amazon Elasticsearch Service em uma VPC e restringe o acesso a um único usuário. O Amazon ES infere o ID da VPC a partir dos IDs especificados da sub-rede e do grupo de segurança.
```
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
```
Resultado:
```
{
"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 obter mais informações, consulte [Criar e gerenciar domínios do Amazon Elasticsearch Service](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html) no *Guia do desenvolvedor do Amazon Elasticsearch Service*.
+ Para ver detalhes da API, consulte [CreateElasticsearchDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/create-elasticsearch-domain.html) na *Referência de comandos da AWS CLI*.
### `describe-elasticsearch-domain-config`
O código de exemplo a seguir mostra como usar `describe-elasticsearch-domain-config`.
**AWS CLI**
**Obter detalhes da configuração do domínio**
O exemplo `describe-elasticsearch-domain-config` a seguir fornece detalhes de configuração para um determinado domínio, juntamente com informações de status para cada componente individual do domínio.
```
aws es describe-elasticsearch-domain-config \
--domain-name cli-example
```
Resultado:
```
{
"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 obter mais informações, consulte [Criar e gerenciar domínios do Amazon Elasticsearch Service](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html) no *Guia do desenvolvedor do Amazon Elasticsearch Service*.
+ Para ver detalhes da API, consulte [DescribeElasticsearchDomainConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/describe-elasticsearch-domain-config.html) na *Referência de comandos da AWS CLI*.
### `describe-elasticsearch-domain`
O código de exemplo a seguir mostra como usar `describe-elasticsearch-domain`.
**AWS CLI**
**Obter detalhes de um único domínio**
O exemplo `describe-elasticsearch-domain` a seguir fornece detalhes de configuração para um determinado domínio.
```
aws es describe-elasticsearch-domain \
--domain-name cli-example
```
Resultado:
```
{
"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 obter mais informações, consulte [Criar e gerenciar domínios do Amazon Elasticsearch Service](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html) no *Guia do desenvolvedor do Amazon Elasticsearch Service*.
+ Para ver detalhes da API, consulte [DescribeElasticsearchDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/describe-elasticsearch-domain.html) na *Referência de comandos da AWS CLI*.
### `describe-elasticsearch-domains`
O código de exemplo a seguir mostra como usar `describe-elasticsearch-domains`.
**AWS CLI**
**Obter detalhes de um ou mais domínios**
O exemplo `describe-elasticsearch-domains` a seguir fornece detalhes de configuração para um ou mais domínios.
```
aws es describe-elasticsearch-domains \
--domain-names cli-example-1 cli-example-2
```
Resultado:
```
{
"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 obter mais informações, consulte [Criar e gerenciar domínios do Amazon Elasticsearch Service](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html) no *Guia do desenvolvedor do Amazon Elasticsearch Service*.
+ Para ver detalhes da API, consulte [DescribeElasticsearchDomains](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/describe-elasticsearch-domains.html) na *Referência de comandos da AWS CLI*.
### `describe-reserved-elasticsearch-instances`
O código de exemplo a seguir mostra como usar `describe-reserved-elasticsearch-instances`.
**AWS CLI**
**Visualizar todas as instâncias reservadas**
O exemplo `describe-elasticsearch-domains` a seguir fornece um resumo de todas as instâncias que você reservou em uma região.
```
aws es describe-reserved-elasticsearch-instances
```
Resultado:
```
{
"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 obter mais informações, consulte [Instâncias reservadas](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/aes-ri.html) no *Guia do desenvolvedor do Amazon Elasticsearch Service*.
+ Para ver detalhes da API, consulte [DescribeReservedElasticsearchInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/describe-reserved-elasticsearch-instances.html) na *Referência de comandos da AWS CLI*.
### `list-domain-names`
O código de exemplo a seguir mostra como usar `list-domain-names`.
**AWS CLI**
**Listar todos os domínios**
O exemplo `list-domain-names` a seguir fornece um resumo rápido de todos os domínios na região.
```
aws es list-domain-names
```
Resultado:
```
{
"DomainNames": [{
"DomainName": "cli-example-1"
},
{
"DomainName": "cli-example-2"
}
]
}
```
Para obter mais informações, consulte [Criar e gerenciar domínios do Amazon Elasticsearch Service](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html) no *Guia do desenvolvedor do Amazon Elasticsearch Service*.
+ Para ver detalhes da API, consulte [ListDomainNames](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/list-domain-names.html) na *Referência de comandos da AWS CLI*.