Elasticsearch

Elasticsearch: Request

cloud.elasticsearch.request {
  auth_type = "API Key"
  key_id = ""
  access_key = ""
  region = ""
  method = "POST"
  url = ""
  query = ""
} as x1

Parameter	Purpose	Example
auth_type	Authentication method	`"API Key"`, `"Basic"`
key_id	Elasticsearch API key ID	`"VuaCfGcBCdbkQm-e5aOx"`
access_key	Elasticsearch API key	`"ui2lp2axTNmsyakw9tvNnw"`
region	Elasticsearch region	`"us-east-1"`, `"eu-west-1"`
method	HTTP method for request	`"GET"`, `"POST"`, `"PUT"`, `"DELETE"`
url	Elasticsearch endpoint URL	`"https://search-domain.region.es.amazonaws.com"`
query	Query body	`{query: {match_all: {}}}`
as	Alias for response	`x1`, `search_response`

Example

cloud.elasticsearch.request {
  auth_type = "API Key"
  key_id = $env.ES_KEY_ID
  access_key = $env.ES_ACCESS_KEY
  region = "us-west-2"
  method = "POST"
  url = "https://my-domain.es.amazonaws.com/products/_search"
  query = {
    query: {
      match: {
        name: "search term"
      }
    }
  }
} as search_results

Makes direct requests to Elasticsearch
Supports all Elasticsearch APIs
Flexible query construction
Returns raw Elasticsearch response

Elasticsearch: Document

cloud.elasticsearch.document {
  auth_type = "API Key"
  key_id = ""
  access_key = ""
  region = ""
  method = "GET"
  index = ""
  doc_id = ""
  doc =
} as x2

Parameter	Purpose	Example
auth_type	Authentication method	`"API Key"`, `"Basic"`
key_id	Elasticsearch API key ID	`"VuaCfGcBCdbkQm-e5aOx"`
access_key	Elasticsearch API key	`"ui2lp2axTNmsyakw9tvNnw"`
region	Elasticsearch region	`"us-east-1"`
method	CRUD operation type	`"GET"`, `"POST"`, `"PUT"`, `"DELETE"`
index	Index name	`"products"`, `"users"`
doc_id	Document identifier	`"123"`, `$item.id`
doc	Document data	`{title: "Product", price: 99.99}`
as	Alias for response	`x2`, `document_result`

Example

cloud.elasticsearch.document {
  auth_type = "API Key"
  key_id = $env.ES_KEY_ID
  access_key = $env.ES_ACCESS_KEY
  region = "us-west-2"
  method = "PUT"
  index = "products"
  doc_id = "prod_123"
  doc = {
    name: "Sample Product",
    price: 29.99,
    category: "electronics"
  }
} as document_response

Performs CRUD operations on documents
Supports create, read, update, delete
Works with specific document IDs
Returns operation result

Elasticsearch: Search Query

cloud.elasticsearch.query {
  auth_type = "API Key"
  key_id = ""
  access_key = ""
  region = ""
  index = ""
  payload =
  expression = []
  size = 0
  from = 0
  sort = []
  included_fields = []
  return_type = "search"
} as x3

Parameter	Purpose	Example
auth_type	Authentication method	`"API Key"`, `"Basic"`
key_id	Elasticsearch API key ID	`"VuaCfGcBCdbkQm-e5aOx"`
access_key	Elasticsearch API key	`"ui2lp2axTNmsyakw9tvNnw"`
region	Elasticsearch region	`"us-east-1"`
index	Index to query	`"products"`
payload	Query payload	`{match: {field: "value"}}`
expression	Query expressions	`["term1", "term2"]`
size	Results per page	`10`, `50`
from	Starting position	`0`, `50`
sort	Sort criteria	`[{field: "asc"}]`
included_fields	Fields to return	`["name", "price"]`
return_type	Response format	`"search"`, `"count"`
as	Alias for results	`x3`, `query_results`

Example

cloud.elasticsearch.query {
  auth_type = "API Key"
  key_id = $env.ES_KEY_ID
  access_key = $env.ES_ACCESS_KEY
  region = "us-west-2"
  index = "products"
  payload = {
    match: {
      category: "electronics"
    }
  }
  size = 20
  from = 0
  sort = [{price: "desc"}]
  included_fields = ["name", "price", "category"]
  return_type = "search"
} as search_results

Performs structured queries
Supports pagination
Configurable field selection
Flexible sorting options
Multiple return type formats

Start

AI

References

Elasticsearch: Request

Elasticsearch: Document

Elasticsearch: Search Query

​ Elasticsearch: Request

​ Elasticsearch: Document

​ Elasticsearch: Search Query

Elasticsearch: Request

Elasticsearch: Document

Elasticsearch: Search Query