Add Basics Scenario for OpenSearch

.doc_gen/metadata/opensearch_metadata.yaml

@@ -1,4 +1,21 @@
 # zexi 0.4.0
+opensearch_Hello:
+  title: Hello &ES;
+  title_abbrev: Hello &ES;
+  synopsis: get started using &ES;.
+  category: Hello
+  languages:
+    Java:
+      versions:
+        - sdk_version: 2
+          github: javav2/example_code/opensearch
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - opensearch.java2.hello.main
+  services:
+    opensearch: {ListVersions}
 opensearch_CreateDomain:
   languages:
     Kotlin:
@@ -65,6 +82,58 @@ opensearch_ListDomainNames:
                 - opensearch.java2.list_domains.main
   services:
     opensearch: {ListDomainNames}
+opensearch_ListTags:
+  languages:
+    Java:
+      versions:
+        - sdk_version: 2
+          github: javav2/example_code/opensearch
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - opensearch.java2.add_tags.main
+  services:
+    opensearch: {ListTags}
+opensearch_AddTags:
+  languages:
+    Java:
+      versions:
+        - sdk_version: 2
+          github: javav2/example_code/opensearch
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - opensearch.java2.add_tags.main
+  services:
+    opensearch: {AddTags}
+opensearch_ChangeProgress:
+  languages:
+    Java:
+      versions:
+        - sdk_version: 2
+          github: javav2/example_code/opensearch
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - opensearch.java2.change_process.main
+  services:
+    opensearch: {ChangeProgress}
+opensearch_DescribeDomain:
+  languages:
+    Java:
+      versions:
+        - sdk_version: 2
+          github: javav2/example_code/opensearch
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - opensearch.java2.update_domain.main
+  services:
+    opensearch: {DescribeDomain}
 opensearch_UpdateDomainConfig:
   languages:
     Kotlin:
@@ -87,3 +156,32 @@ opensearch_UpdateDomainConfig:
                 - opensearch.java2.update_domain.main
   services:
     opensearch: {UpdateDomainConfig}
+opensearch_Scenario:
+  title: Learn core operations for &ESlong; using an &AWS; SDK
+  title_abbrev: Learn &ES; core operations
+  synopsis_list:
+    - Create an &ES; domain.
+    - Provides detailed information about a specific &ES; domain.
+    - Lists all the &ES; domains owned by the account.
+    - Waits until the &ES; domain's change status reaches a completed state.
+    - Modifies the configuration of an existing &ES; domain.
+    - Add a tag to the &ES; domain.
+    - Lists the tags associated with an &ES; domain.
+    - Removes tags from an &ES; domain.
+    - Deletes the &ES; domain.
+  category: Basics
+  languages:
+    Java:
+      versions:
+        - sdk_version: 2
+          github: javav2/example_code/batch
+          sdkguide:
+          excerpts:
+            - description: Run an interactive scenario demonstrating &ES; features.
+              snippet_tags:
+                - opensearch.java2.scenario.main
+            - description: A wrapper class for &ES; SDK methods.
+              snippet_tags:
+                - opensearch.java2.actions.main
+  services:
+    opensearch: {CreateDomain, DeleteDomain, DescribeDomain, ListDomainNames, UpdateDomainConfig, DescribeDomainChangeProgress, AddTags, ListTags}

basics_scenarios/opensearch_scenario/README.md

@@ -0,0 +1,51 @@
+# Amazon OpenSearch Service Basic Scenario
+
+## Overview
+
+ This Amazon OpenSearch Service basic scenario demonstrates how to interact with the Amazon OpenSearch service using an AWS SDK.  The scenario covers various operations such as creating an OpenSearch domain, modifying a domain, waiting for changes to the domain to enter a complete state, and so on. 
+
+ Here are the top five service operations this scenario covers. 
+
+**Create an Amazon OpenSearch Domain**:
+   - Description: This operation creates a new Amazon OpenSearch domain, which is a managed instance of the OpenSearch engine.
+
+2. **Describe the Amazon OpenSearch Domain**:
+   - Description: This operation retrieves information about the specified Amazon OpenSearch domain.
+   - The method `describeDomain(domainName)` is called to obtain the Amazon Resource Name (ARN) of the specified OpenSearch domain.
+
+3. **List the Domains in Your Account**:
+   - Description: This operation lists all the Amazon OpenSearch domains in the current AWS account.
+   - The method `listAllDomains()` is called to retrieve a list of all the OpenSearch domains available in the account.
+
+4. **Wait until the Domain's Change Status Reaches a Completed State**:
+   - Description: This operation waits until the change status of the specified Amazon OpenSearch domain reaches a completed state.
+   - When making changes to an OpenSearch domain, such as scaling the number of data nodes or updating the OpenSearch version, the domain goes through a change process. This method, `domainChangeProgress(domainName)`, waits until the change status of the specified domain reaches a completed state, which can take several minutes to several hours, depending on the complexity of the change and the current load on the OpenSearch service.
+   Note this operation may take up to 20 minutes. 
+
+5. **Modify the Domain**:
+   - Description: This operation modifies the cluster configuration of the specified Amazon OpenSearch domain, such as the instance count.
+   - The flexibility to modify the OpenSearch domain's configuration is particularly useful when the data or usage patterns change over time, as you can easily scale the domain to meet the new requirements without having to recreate the entire domain.
+   - The method `updateSpecificDomain(domainName)` is called to update the configuration of the specified OpenSearch domain.
+
+Note: These steps are not the complete program, but summarizes the 5 high-level steps. See the Eng Spec for a complete listing of operations. 
+
+### Resources
+
+This scenario does not require any additional AWS resources to run.
+
+
+## Implementations
+
+This scenario example will be implemented in the following languages:
+
+- Java
+- Python
+- JavaScript
+
+## Additional reading
+
+- [Amazon OpenSearch](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/what-is.html)
+
+---
+
+Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0