Hay más ejemplos de AWS SDK disponibles en el GitHub repositorio de [ejemplos de AWS Doc SDK](https://github.com/awsdocs/aws-doc-sdk-examples).
Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
# Acciones para el uso OpenSearch del servicio AWS SDKs
Los siguientes ejemplos de código muestran cómo realizar acciones OpenSearch de servicio individuales con AWS SDKs. Cada ejemplo incluye un enlace a GitHub, donde puede encontrar instrucciones para configurar y ejecutar el código.
Los siguientes ejemplos incluyen solo las acciones que se utilizan con mayor frecuencia. Para obtener una lista completa, consulta la [referencia de la API OpenSearch de Amazon Service](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/Welcome.html).
**Topics**
+ [`AddTags`](opensearch_example_opensearch_AddTags_section.md)
+ [`ChangeProgress`](opensearch_example_opensearch_ChangeProgress_section.md)
+ [`CreateDomain`](opensearch_example_opensearch_CreateDomain_section.md)
+ [`DeleteDomain`](opensearch_example_opensearch_DeleteDomain_section.md)
+ [`DescribeDomain`](opensearch_example_opensearch_DescribeDomain_section.md)
+ [`ListDomainNames`](opensearch_example_opensearch_ListDomainNames_section.md)
+ [`ListTags`](opensearch_example_opensearch_ListTags_section.md)
+ [`UpdateDomainConfig`](opensearch_example_opensearch_UpdateDomainConfig_section.md)
# `AddTags`Úselo con un AWS SDK
En el siguiente ejemplo de código, se muestra cómo utilizar `AddTags`.
Los ejemplos de acciones son extractos de código de programas más grandes y deben ejecutarse en contexto. Puede ver esta acción en contexto en el siguiente ejemplo de código:
+ [Conozca las operaciones principales del OpenSearch servicio](opensearch_example_opensearch_Scenario_section.md)
------
#### [ Java ]
**SDK para Java 2.x**
Hay más en marcha GitHub. Busque el ejemplo completo y aprenda a configurar y ejecutar en el [Repositorio de ejemplos de código de AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/opensearch#code-examples).
```
/**
* Asynchronously adds tags to an Amazon OpenSearch Service domain.
* @param domainARN the Amazon Resource Name (ARN) of the Amazon OpenSearch Service domain to add tags to
* @return a {@link CompletableFuture} that completes when the tags have been successfully added to the domain,
* or throws a {@link RuntimeException} if the operation fails
*/
public CompletableFuture addDomainTagsAsync(String domainARN) {
Tag tag1 = Tag.builder()
.key("service")
.value("OpenSearch")
.build();
Tag tag2 = Tag.builder()
.key("instances")
.value("m3.2xlarge")
.build();
List tagList = new ArrayList<>();
tagList.add(tag1);
tagList.add(tag2);
AddTagsRequest addTagsRequest = AddTagsRequest.builder()
.arn(domainARN)
.tagList(tagList)
.build();
return getAsyncClient().addTags(addTagsRequest)
.whenComplete((response, exception) -> {
if (exception != null) {
throw new RuntimeException("Failed to add tags to the domain: " + domainARN, exception);
} else {
logger.info("Added Tags");
}
});
}
```
+ Para obtener más información sobre la API, consulta [AddTags](https://docs.aws.amazon.com/goto/SdkForJavaV2/es-2021-01-01/AddTags)la *Referencia AWS SDK for Java 2.x de la API*.
------
# `ChangeProgress`Úselo con un AWS SDK
En el siguiente ejemplo de código, se muestra cómo utilizar `ChangeProgress`.
------
#### [ Java ]
**SDK para Java 2.x**
Hay más en marcha GitHub. Busque el ejemplo completo y aprenda a configurar y ejecutar en el [Repositorio de ejemplos de código de AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/opensearch#code-examples).
```
/**
* Asynchronously checks the progress of a domain change operation in Amazon OpenSearch Service.
* @param domainName the name of the OpenSearch domain to check the progress for
* @return a {@link CompletableFuture} that completes when the domain change operation is completed
*/
public CompletableFuture domainChangeProgressAsync(String domainName) {
DescribeDomainChangeProgressRequest request = DescribeDomainChangeProgressRequest.builder()
.domainName(domainName)
.build();
return CompletableFuture.runAsync(() -> {
boolean isCompleted = false;
long startTime = System.currentTimeMillis();
while (!isCompleted) {
try {
// Handle the async client call using `join` to block synchronously for the result
DescribeDomainChangeProgressResponse response = getAsyncClient()
.describeDomainChangeProgress(request)
.handle((resp, ex) -> {
if (ex != null) {
throw new RuntimeException("Failed to check domain progress", ex);
}
return resp;
}).join();
String state = response.changeProgressStatus().statusAsString(); // Get the status as string
if ("COMPLETED".equals(state)) {
logger.info("\nOpenSearch domain status: Completed");
isCompleted = true;
} else {
for (int i = 0; i < 5; i++) {
long elapsedTimeInSeconds = (System.currentTimeMillis() - startTime) / 1000;
String formattedTime = String.format("%02d:%02d", elapsedTimeInSeconds / 60, elapsedTimeInSeconds % 60);
System.out.print("\rOpenSearch domain state: " + state + " | Time Elapsed: " + formattedTime + " ");
System.out.flush();
Thread.sleep(1_000);
}
}
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
throw new RuntimeException("Thread was interrupted", e);
}
}
});
}
```
+ Para obtener más información sobre la API, consulta [ChangeProgress](https://docs.aws.amazon.com/goto/SdkForJavaV2/es-2021-01-01/ChangeProgress)la *Referencia AWS SDK for Java 2.x de la API*.
------
# `CreateDomain`Úselo con un AWS SDK
Los siguientes ejemplos de código muestran cómo utilizar `CreateDomain`.
Los ejemplos de acciones son extractos de código de programas más grandes y deben ejecutarse en contexto. Puede ver esta acción en contexto en el siguiente ejemplo de código:
+ [Conozca las operaciones principales del OpenSearch servicio](opensearch_example_opensearch_Scenario_section.md)
------
#### [ Java ]
**SDK para Java 2.x**
Hay más en marcha GitHub. Busque el ejemplo completo y aprenda a configurar y ejecutar en el [Repositorio de ejemplos de código de AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/opensearch#code-examples).
```
/**
* Creates a new OpenSearch domain asynchronously.
* @param domainName the name of the new OpenSearch domain to create
* @return a {@link CompletableFuture} containing the domain ID of the newly created domain
*/
public CompletableFuture createNewDomainAsync(String domainName) {
ClusterConfig clusterConfig = ClusterConfig.builder()
.dedicatedMasterEnabled(true)
.dedicatedMasterCount(3)
.dedicatedMasterType("t2.small.search")
.instanceType("t2.small.search")
.instanceCount(5)
.build();
EBSOptions ebsOptions = EBSOptions.builder()
.ebsEnabled(true)
.volumeSize(10)
.volumeType(VolumeType.GP2)
.build();
NodeToNodeEncryptionOptions encryptionOptions = NodeToNodeEncryptionOptions.builder()
.enabled(true)
.build();
CreateDomainRequest domainRequest = CreateDomainRequest.builder()
.domainName(domainName)
.engineVersion("OpenSearch_1.0")
.clusterConfig(clusterConfig)
.ebsOptions(ebsOptions)
.nodeToNodeEncryptionOptions(encryptionOptions)
.build();
logger.info("Sending domain creation request...");
return getAsyncClient().createDomain(domainRequest)
.handle( (createResponse, throwable) -> {
if (createResponse != null) {
logger.info("Domain status is {}", createResponse.domainStatus().changeProgressDetails().configChangeStatusAsString());
logger.info("Domain Id is {}", createResponse.domainStatus().domainId());
return createResponse.domainStatus().domainId();
}
throw new RuntimeException("Failed to create domain", throwable);
});
}
```
+ Para obtener más información sobre la API, consulta [CreateDomain](https://docs.aws.amazon.com/goto/SdkForJavaV2/es-2021-01-01/CreateDomain)la *Referencia AWS SDK for Java 2.x de la API*.
------
#### [ Kotlin ]
**SDK para Kotlin**
Hay más información al respecto GitHub. Busque el ejemplo completo y aprenda a configurar y ejecutar en el [Repositorio de ejemplos de código de AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/opensearch#code-examples).
```
suspend fun createNewDomain(domainNameVal: String?) {
val clusterConfigOb =
ClusterConfig {
dedicatedMasterEnabled = true
dedicatedMasterCount = 3
dedicatedMasterType = OpenSearchPartitionInstanceType.fromValue("t2.small.search")
instanceType = OpenSearchPartitionInstanceType.fromValue("t2.small.search")
instanceCount = 5
}
val ebsOptionsOb =
EbsOptions {
ebsEnabled = true
volumeSize = 10
volumeType = VolumeType.Gp2
}
val encryptionOptionsOb =
NodeToNodeEncryptionOptions {
enabled = true
}
val request =
CreateDomainRequest {
domainName = domainNameVal
engineVersion = "OpenSearch_1.0"
clusterConfig = clusterConfigOb
ebsOptions = ebsOptionsOb
nodeToNodeEncryptionOptions = encryptionOptionsOb
}
println("Sending domain creation request...")
OpenSearchClient.fromEnvironment { region = "us-east-1" }.use { searchClient ->
val createResponse = searchClient.createDomain(request)
println("Domain status is ${createResponse.domainStatus}")
println("Domain Id is ${createResponse.domainStatus?.domainId}")
}
}
```
+ Para obtener más información sobre la API, consulta [CreateDomain](https://sdk.amazonaws.com/kotlin/api/latest/index.html)la *referencia sobre el AWS SDK para la API de Kotlin*.
------
# Úselo `DeleteDomain` con un SDK AWS
Los siguientes ejemplos de código muestran cómo utilizar `DeleteDomain`.
Los ejemplos de acciones son extractos de código de programas más grandes y deben ejecutarse en contexto. Puede ver esta acción en contexto en el siguiente ejemplo de código:
+ [Conozca las operaciones principales del OpenSearch servicio](opensearch_example_opensearch_Scenario_section.md)
------
#### [ Java ]
**SDK para Java 2.x**
Hay más en marcha GitHub. Busque el ejemplo completo y aprenda a configurar y ejecutar en el [Repositorio de ejemplos de código de AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/opensearch#code-examples).
```
/**
* Deletes a specific domain asynchronously.
* @param domainName the name of the domain to be deleted
* @return a {@link CompletableFuture} that completes when the domain has been deleted
* or throws a {@link RuntimeException} if the deletion fails
*/
public CompletableFuture deleteSpecificDomainAsync(String domainName) {
DeleteDomainRequest domainRequest = DeleteDomainRequest.builder()
.domainName(domainName)
.build();
// Delete domain asynchronously
return getAsyncClient().deleteDomain(domainRequest)
.whenComplete((response, exception) -> {
if (exception != null) {
throw new RuntimeException("Failed to delete the domain: " + domainName, exception);
}
});
}
```
+ Para obtener más información sobre la API, consulta [DeleteDomain](https://docs.aws.amazon.com/goto/SdkForJavaV2/es-2021-01-01/DeleteDomain)la *Referencia AWS SDK for Java 2.x de la API*.
------
#### [ Kotlin ]
**SDK para Kotlin**
Hay más información al respecto GitHub. Busque el ejemplo completo y aprenda a configurar y ejecutar en el [Repositorio de ejemplos de código de AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/opensearch#code-examples).
```
suspend fun deleteSpecificDomain(domainNameVal: String) {
val request =
DeleteDomainRequest {
domainName = domainNameVal
}
OpenSearchClient.fromEnvironment { region = "us-east-1" }.use { searchClient ->
searchClient.deleteDomain(request)
println("$domainNameVal was successfully deleted.")
}
}
```
+ Para obtener más información sobre la API, consulta [DeleteDomain](https://sdk.amazonaws.com/kotlin/api/latest/index.html)la *referencia sobre el AWS SDK para la API de Kotlin*.
------
# Úselo `DescribeDomain` con un SDK AWS
En el siguiente ejemplo de código, se muestra cómo utilizar `DescribeDomain`.
Los ejemplos de acciones son extractos de código de programas más grandes y deben ejecutarse en contexto. Puede ver esta acción en contexto en el siguiente ejemplo de código:
+ [Conozca las operaciones principales del OpenSearch servicio](opensearch_example_opensearch_Scenario_section.md)
------
#### [ Java ]
**SDK para Java 2.x**
Hay más en marcha GitHub. Busque el ejemplo completo y aprenda a configurar y ejecutar en el [Repositorio de ejemplos de código de AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/opensearch#code-examples).
```
/**
* Describes the specified domain asynchronously.
*
* @param domainName the name of the domain to describe
* @return a {@link CompletableFuture} that completes with the ARN of the domain
* @throws RuntimeException if the domain description fails
*/
public CompletableFuture describeDomainAsync(String domainName) {
DescribeDomainRequest request = DescribeDomainRequest.builder()
.domainName(domainName)
.build();
return getAsyncClient().describeDomain(request)
.handle((response, exception) -> { // Handle both response and exception
if (exception != null) {
throw new RuntimeException("Failed to describe domain", exception);
}
DomainStatus domainStatus = response.domainStatus();
String endpoint = domainStatus.endpoint();
String arn = domainStatus.arn();
String engineVersion = domainStatus.engineVersion();
logger.info("Domain endpoint is: " + endpoint);
logger.info("ARN: " + arn);
System.out.println("Engine version: " + engineVersion);
return arn; // Return ARN when successful
});
}
```
+ Para obtener más información sobre la API, consulta [DescribeDomain](https://docs.aws.amazon.com/goto/SdkForJavaV2/es-2021-01-01/DescribeDomain)la *Referencia AWS SDK for Java 2.x de la API*.
------
# `ListDomainNames`Úselo con un AWS SDK
Los siguientes ejemplos de código muestran cómo utilizar `ListDomainNames`.
Los ejemplos de acciones son extractos de código de programas más grandes y deben ejecutarse en contexto. Puede ver esta acción en contexto en el siguiente ejemplo de código:
+ [Conozca las operaciones principales del OpenSearch servicio](opensearch_example_opensearch_Scenario_section.md)
------
#### [ Java ]
**SDK para Java 2.x**
Hay más en marcha GitHub. Busque el ejemplo completo y aprenda a configurar y ejecutar en el [Repositorio de ejemplos de código de AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/opensearch#code-examples).
```
/**
* Asynchronously lists all the domains in the current AWS account.
* @return a {@link CompletableFuture} that, when completed, contains a list of {@link DomainInfo} objects representing
* the domains in the account.
* @throws RuntimeException if there was a failure while listing the domains.
*/
public CompletableFuture> listAllDomainsAsync() {
ListDomainNamesRequest namesRequest = ListDomainNamesRequest.builder()
.engineType("OpenSearch")
.build();
return getAsyncClient().listDomainNames(namesRequest)
.handle((response, exception) -> {
if (exception != null) {
throw new RuntimeException("Failed to list all domains", exception);
}
return response.domainNames(); // Return the list of domain names on success
});
}
```
+ Para obtener más información sobre la API, consulta [ListDomainNames](https://docs.aws.amazon.com/goto/SdkForJavaV2/es-2021-01-01/ListDomainNames)la *Referencia AWS SDK for Java 2.x de la API*.
------
#### [ Kotlin ]
**SDK para Kotlin**
Hay más información al respecto GitHub. Busque el ejemplo completo y aprenda a configurar y ejecutar en el [Repositorio de ejemplos de código de AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/opensearch#code-examples).
```
suspend fun listAllDomains() {
OpenSearchClient.fromEnvironment { region = "us-east-1" }.use { searchClient ->
val response: ListDomainNamesResponse = searchClient.listDomainNames(ListDomainNamesRequest {})
response.domainNames?.forEach { domain ->
println("Domain name is " + domain.domainName)
}
}
}
```
+ Para obtener más información sobre la API, consulta [ListDomainNames](https://sdk.amazonaws.com/kotlin/api/latest/index.html)la *referencia sobre el AWS SDK para la API de Kotlin*.
------
# Úselo `ListTags` con un SDK AWS
En el siguiente ejemplo de código, se muestra cómo utilizar `ListTags`.
Los ejemplos de acciones son extractos de código de programas más grandes y deben ejecutarse en contexto. Puede ver esta acción en contexto en el siguiente ejemplo de código:
+ [Conozca las operaciones principales del OpenSearch servicio](opensearch_example_opensearch_Scenario_section.md)
------
#### [ Java ]
**SDK para Java 2.x**
Hay más en marcha GitHub. Busque el ejemplo completo y aprenda a configurar y ejecutar en el [Repositorio de ejemplos de código de AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/opensearch#code-examples).
```
/**
* Asynchronously adds tags to an Amazon OpenSearch Service domain.
* @param domainARN the Amazon Resource Name (ARN) of the Amazon OpenSearch Service domain to add tags to
* @return a {@link CompletableFuture} that completes when the tags have been successfully added to the domain,
* or throws a {@link RuntimeException} if the operation fails
*/
public CompletableFuture addDomainTagsAsync(String domainARN) {
Tag tag1 = Tag.builder()
.key("service")
.value("OpenSearch")
.build();
Tag tag2 = Tag.builder()
.key("instances")
.value("m3.2xlarge")
.build();
List tagList = new ArrayList<>();
tagList.add(tag1);
tagList.add(tag2);
AddTagsRequest addTagsRequest = AddTagsRequest.builder()
.arn(domainARN)
.tagList(tagList)
.build();
return getAsyncClient().addTags(addTagsRequest)
.whenComplete((response, exception) -> {
if (exception != null) {
throw new RuntimeException("Failed to add tags to the domain: " + domainARN, exception);
} else {
logger.info("Added Tags");
}
});
}
```
+ Para obtener más información sobre la API, consulta [ListTags](https://docs.aws.amazon.com/goto/SdkForJavaV2/es-2021-01-01/ListTags)la *Referencia AWS SDK for Java 2.x de la API*.
------
# `UpdateDomainConfig`Úselo con un AWS SDK
Los siguientes ejemplos de código muestran cómo utilizar `UpdateDomainConfig`.
Los ejemplos de acciones son extractos de código de programas más grandes y deben ejecutarse en contexto. Puede ver esta acción en contexto en el siguiente ejemplo de código:
+ [Conozca las operaciones principales del OpenSearch servicio](opensearch_example_opensearch_Scenario_section.md)
------
#### [ Java ]
**SDK para Java 2.x**
Hay más en marcha GitHub. Busque el ejemplo completo y aprenda a configurar y ejecutar en el [Repositorio de ejemplos de código de AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/opensearch#code-examples).
```
/**
* Updates the configuration of a specific domain asynchronously.
* @param domainName the name of the domain to update
* @return a {@link CompletableFuture} that represents the asynchronous operation of updating the domain configuration
*/
public CompletableFuture updateSpecificDomainAsync(String domainName) {
ClusterConfig clusterConfig = ClusterConfig.builder()
.instanceCount(3)
.build();
UpdateDomainConfigRequest updateDomainConfigRequest = UpdateDomainConfigRequest.builder()
.domainName(domainName)
.clusterConfig(clusterConfig)
.build();
return getAsyncClient().updateDomainConfig(updateDomainConfigRequest)
.whenComplete((response, exception) -> {
if (exception != null) {
throw new RuntimeException("Failed to update the domain configuration", exception);
}
// Handle success if needed (e.g., logging or additional actions)
});
}
```
+ Para obtener más información sobre la API, consulta [UpdateDomainConfig](https://docs.aws.amazon.com/goto/SdkForJavaV2/es-2021-01-01/UpdateDomainConfig)la *Referencia AWS SDK for Java 2.x de la API*.
------
#### [ Kotlin ]
**SDK para Kotlin**
Hay más información al respecto GitHub. Busque el ejemplo completo y aprenda a configurar y ejecutar en el [Repositorio de ejemplos de código de AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/opensearch#code-examples).
```
suspend fun updateSpecificDomain(domainNameVal: String?) {
val clusterConfigOb =
ClusterConfig {
instanceCount = 3
}
val request =
UpdateDomainConfigRequest {
domainName = domainNameVal
clusterConfig = clusterConfigOb
}
println("Sending domain update request...")
OpenSearchClient.fromEnvironment { region = "us-east-1" }.use { searchClient ->
val updateResponse = searchClient.updateDomainConfig(request)
println("Domain update response from Amazon OpenSearch Service:")
println(updateResponse.toString())
}
}
```
+ Para obtener más información sobre la API, consulta [UpdateDomainConfig](https://sdk.amazonaws.com/kotlin/api/latest/index.html)la *referencia sobre el AWS SDK para la API de Kotlin*.
------