Skip to main content

​
/images/icons/xs_temp.svg AWS OpenSearch: Request

cloud.aws.opensearch.request {
  auth_type = "IAM"
  key_id = ""
  access_key = ""
  region = ""
  method = "GET"
  url = ""
  query =
} as x1
ParameterPurposeExample
auth_typeAuthentication type for AWS"IAM"
key_idAWS access key ID"AKIAXXXXXXXXXXXXXXXX"
access_keyAWS secret access key"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
regionAWS region for OpenSearch"us-east-1", "eu-west-1"
methodHTTP method for the request"GET", "POST", "PUT", "DELETE"
urlOpenSearch endpoint URL"https://search-domain.region.es.amazonaws.com"
queryQuery to send to OpenSearch{query: {match_all: {}}}
asAlias to reference the responsex1, search_results
cloud.aws.opensearch.request {
  auth_type = "IAM"
  key_id = $env.AWS_KEY_ID
  access_key = $env.AWS_SECRET_KEY
  region = "us-west-2"
  method = "GET"
  url = "https://search-mydomain.us-west-2.es.amazonaws.com/index/_search"
  query = {
    query: {
      match: {
        title: "search term"
      }
    }
  }
} as search_response
  • Makes requests to AWS OpenSearch service
  • Supports IAM authentication
  • Can perform search and index operations
  • Returns OpenSearch response data

​
/images/icons/xs_temp.svg AWS OpenSearch: Document (CRUD)

cloud.aws.opensearch.document {
  auth_type = "IAM"
  key_id = ""
  access_key = ""
  region = ""
  method = "GET"
  index = ""
  doc_id = ""
  doc =
} as x2
ParameterPurposeExample
auth_typeAuthentication type for AWS"IAM"
key_idAWS access key ID"AKIAXXXXXXXXXXXXXXXX"
access_keyAWS secret access key"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
regionAWS region for OpenSearch"us-east-1", "eu-west-1"
methodCRUD operation type"GET", "POST", "PUT", "DELETE"
indexOpenSearch index name"products", "users"
doc_idDocument identifier"123", $item.id
docDocument data for create/update{title: "New Product", price: 99.99}
asAlias to reference the responsex2, document_result
cloud.aws.opensearch.document {
  auth_type = "IAM"
  key_id = $env.AWS_KEY_ID
  access_key = $env.AWS_SECRET_KEY
  region = "us-west-2"
  method = "POST"
  index = "products"
  doc_id = "prod_123"
  doc = {
    name: "Sample Product",
    description: "A great product",
    price: 29.99
  }
} as document_response
  • Performs CRUD operations on OpenSearch documents
  • Supports create, read, update, delete operations
  • Works with specific document IDs
  • Returns operation result data

​
/images/icons/xs_temp.svg AWS OpenSearch: Search Query

cloud.aws.opensearch.query {
  auth_type = "IAM"
  key_id = ""
  access_key = ""
  region = ""
  index = ""
  payload =
  expression = []
  size = 0
  from = 0
  sort = []
  included_fields = []
  return_type = "search"
} as x3
ParameterPurposeExample
auth_typeAuthentication type for AWS"IAM"
key_idAWS access key ID"AKIAXXXXXXXXXXXXXXXX"
access_keyAWS secret access key"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
regionAWS region for OpenSearch"us-east-1", "eu-west-1"
indexOpenSearch index to query"products", "users"
payloadQuery payload{match: {field: "value"}}
expressionArray of query expressions["term1", "term2"]
sizeNumber of results to return10, 50, 100
fromStarting position for results0, 20, 100
sortArray of sort criteria[{field: "asc"}]
included_fieldsFields to include in results["name", "price", "description"]
return_typeType of search response"search", "count"
asAlias to reference the resultsx3, search_results
cloud.aws.opensearch.query {
  auth_type = "IAM"
  key_id = $env.AWS_KEY_ID
  access_key = $env.AWS_SECRET_KEY
  region = "us-west-2"
  index = "products"
  payload = {
    match: {
      name: "search term"
    }
  }
  expression = ["category:electronics"]
  size = 20
  from = 0
  sort = [{price: "desc"}]
  included_fields = ["name", "price", "category"]
  return_type = "search"
} as product_results
  • Performs advanced queries on OpenSearch
  • Supports pagination with size and from
  • Can sort and filter results
  • Allows field selection
  • Supports different return types
⌘I