Skip to main content

​
/images/icons/xs_temp.svg Elasticsearch: Request

cloud.elasticsearch.request {
  auth_type = "API Key"
  key_id = ""
  access_key = ""
  region = ""
  method = "POST"
  url = ""
  query = ""
} as x1
ParameterPurposeExample
auth_typeAuthentication method"API Key", "Basic"
key_idElasticsearch API key ID"VuaCfGcBCdbkQm-e5aOx"
access_keyElasticsearch API key"ui2lp2axTNmsyakw9tvNnw"
regionElasticsearch region"us-east-1", "eu-west-1"
methodHTTP method for request"GET", "POST", "PUT", "DELETE"
urlElasticsearch endpoint URL"https://search-domain.region.es.amazonaws.com"
queryQuery body{query: {match_all: {}}}
asAlias for responsex1, search_response
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

​
/images/icons/xs_temp.svg Elasticsearch: Document

cloud.elasticsearch.document {
  auth_type = "API Key"
  key_id = ""
  access_key = ""
  region = ""
  method = "GET"
  index = ""
  doc_id = ""
  doc =
} as x2
ParameterPurposeExample
auth_typeAuthentication method"API Key", "Basic"
key_idElasticsearch API key ID"VuaCfGcBCdbkQm-e5aOx"
access_keyElasticsearch API key"ui2lp2axTNmsyakw9tvNnw"
regionElasticsearch region"us-east-1"
methodCRUD operation type"GET", "POST", "PUT", "DELETE"
indexIndex name"products", "users"
doc_idDocument identifier"123", $item.id
docDocument data{title: "Product", price: 99.99}
asAlias for responsex2, document_result
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

​
/images/icons/xs_temp.svg 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
ParameterPurposeExample
auth_typeAuthentication method"API Key", "Basic"
key_idElasticsearch API key ID"VuaCfGcBCdbkQm-e5aOx"
access_keyElasticsearch API key"ui2lp2axTNmsyakw9tvNnw"
regionElasticsearch region"us-east-1"
indexIndex to query"products"
payloadQuery payload{match: {field: "value"}}
expressionQuery expressions["term1", "term2"]
sizeResults per page10, 50
fromStarting position0, 50
sortSort criteria[{field: "asc"}]
included_fieldsFields to return["name", "price"]
return_typeResponse format"search", "count"
asAlias for resultsx3, query_results
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
⌘I