{"id":22117720,"url":"https://github.com/kineticcafe/ex_aws_cloud_search","last_synced_at":"2025-07-25T11:32:42.103Z","repository":{"id":57498949,"uuid":"141965586","full_name":"KineticCafe/ex_aws_cloud_search","owner":"KineticCafe","description":"A CloudSearch service module for ex_aws.","archived":false,"fork":false,"pushed_at":"2022-10-25T19:15:47.000Z","size":37,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-11-29T12:56:35.837Z","etag":null,"topics":["aws-cloudsearch","elixir"],"latest_commit_sha":null,"homepage":"","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KineticCafe.png","metadata":{"files":{"readme":"README.md","changelog":"Changelog.md","contributing":"Contributing.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-07-23T05:29:52.000Z","updated_at":"2022-10-09T02:11:08.000Z","dependencies_parsed_at":"2022-09-06T17:11:49.383Z","dependency_job_id":null,"html_url":"https://github.com/KineticCafe/ex_aws_cloud_search","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KineticCafe%2Fex_aws_cloud_search","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KineticCafe%2Fex_aws_cloud_search/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KineticCafe%2Fex_aws_cloud_search/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KineticCafe%2Fex_aws_cloud_search/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KineticCafe","download_url":"https://codeload.github.com/KineticCafe/ex_aws_cloud_search/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227570043,"owners_count":17787839,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws-cloudsearch","elixir"],"created_at":"2024-12-01T13:38:52.943Z","updated_at":"2024-12-01T13:38:53.590Z","avatar_url":"https://github.com/KineticCafe.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ExAws.CloudSearch\n\n[![Build Status][build status svg]][build status]\n\nAn [ex\\_aws][] service module for AWS [CloudSearch][].\n\n## Installation\n\nThe package can be installed by adding `ex_aws_cloud_search` to your list of\ndependencies in `mix.exs` along with `:ex_aws_cloud_search` and your preferred\nJSON codec and HTTP client.\n\nIf you are using the [structured search syntax][sss], you may wish to use\n[csquery][].\n\n```elixir\ndef deps do\n  [\n    {:ex_aws, \"~\u003e 2.0\"},\n    {:ex_aws_s3, \"~\u003e 1.0\"},\n    {:poison, \"~\u003e 3.0\"},\n    {:hackney, \"~\u003e 1.9\"},\n    {:csquery, \"~\u003e 1.0\"} # Optional, but recommended.\n  ]\nend\n```\n\nDocumentation can be found at [HexDocs.pm][].\n\n## Configuration\n\nThe request configuration for `ExAws.CloudSearch` is a little different than\nmost other AWS services, in that it requires an additional configuration\nparameter to know what host to use for document management or searches. When\nconfiguring, add a `search_domain` configuration.\n\n```elixir\nconfig :ex_aws,\n  access_key_id: [{:system, \"AWS_ACCESS_KEY_ID\"}, {:aws_profile, \"default\", 30}],\n  secret_access_key: [{:system, \"AWS_SECRET_ACCESS_KEY\"}, {:aws_profile, \"default\", 30}],\n  region: \"us-west-2\",\n  search_domain: \"exaws-search-test-d3adbeef65rvt\"\n```\n\nThe actual host will be chosen based on the `search_domain` provided. As with\nall `ExAws` requests, this may be provided a runtime:\n\n```elixir\n\"José\"\n|\u003e ExAws.CloudSearch.search()\n|\u003e ExAws.request!(region: \"us-west-2\", search_domain: \"exaws-search-test-d3adbeef65rvt\")\n```\n\n## CSQuery Integration\n\nDuring search construction, if a `CSQuery.Expression` is provided as the query,\n`ExAws.CloudSearch` will also configure the query parser to be structured and\nit will use `CSQuery.to_query/1` to produce the query string. (If `CSQuery` is\nnot loaded, an error will be thrown.)\n\n## Planned Features\n\n- [x] Search - 0.1.0\n- [x] Suggest - 0.2.0\n- [x] Document management (add, update, delete) - 0.2.0\n- [x] Configuration - 0.2.0\n- [ ] Improved configuration hygiene by providing more helper structs and\n      functions.\n- [ ] Tests - 1.0.0\n\n## Community and Contributing\n\nWe welcome your contributions, as described in [Contributing.md][]. Like all\nKinetic Cafe [open source projects][], is under the Kinetic Cafe Open Source\n[Code of Conduct][kccoc].\n\n[ex\\_aws]: https://github.com/ex-aws\n[hexdocs.pm]: https://hexdocs.pm/ex_aws_cloud_search\n[build status svg]: https://travis-ci.org/KineticCafe/csquery.svg?branch=master\n[build status]: https://travis-ci.org/KineticCafe/csquery\n[contributing.md]: Contributing.md\n[open source projects]: https://github.com/KineticCafe\n[kccoc]: https://github.com/KineticCafe/code-of-conduct\n[cloudsearch]: https://docs.aws.amazon.com/cloudsearch/\n[sss]: https://docs.aws.amazon.com/cloudsearch/latest/developerguide/search-api.html#structured-search-syntax\n[csquery]: https://github.com/KineticCafe/csquery\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkineticcafe%2Fex_aws_cloud_search","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkineticcafe%2Fex_aws_cloud_search","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkineticcafe%2Fex_aws_cloud_search/lists"}