You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents.
The endpoints for submitting UploadDocuments, Search, and Suggest requests are domain-specific. To get the endpoints for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. The domain endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. You submit suggest requests to the search endpoint.
For more information, see the Amazon CloudSearch Developer Guide.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-cloudsearch-domain-browser\n```\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`CloudSearchDomainClient`) and the commands you need, for example `UploadDocumentsCommand`:\n\n```javascript\n//JavaScript\nconst {\n CloudSearchDomainClient\n} = require(\"@aws-sdk/client-cloudsearch-domain-browser/CloudSearchDomainClient\");\nconst {\n UploadDocumentsCommand\n} = require(\"@aws-sdk/client-cloudsearch-domain-browser/commands/UploadDocumentsCommand\");\n```\n\n```javascript\n//TypeScript\nimport { CloudSearchDomainClient } from \"@aws-sdk/client-cloudsearch-domain-browser/CloudSearchDomainClient\";\nimport { UploadDocumentsCommand } from \"@aws-sdk/client-cloudsearch-domain-browser/commands/UploadDocumentsCommand\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst cloudSearchDomain = new CloudSearchDomainClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n documents: /**a blob value*/\n /**You can supply readable stream to streaming input. e.g. (await fetch(input)).body */,\n contentType: /**a string value*/,\n};\nconst uploadDocumentsCommand = new UploadDocumentsCommand(params);\ncloudSearchDomain.send(uploadDocumentsCommand).then(data => {\n // do something\n}).catch(error => {\n // error handling\n})\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await cloudSearchDomain.send(uploadDocumentsCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\ncloudSearchDomain.send(uploadDocumentsCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/@aws-sdk/client-cloudsearch-domain-browser/CloudSearchDomain\";\nconst cloudSearchDomain = new AWS.CloudSearchDomain({ region: \"region\" });\ncloudSearchDomain.uploadDocuments(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await cloudSearchDomain.send(uploadDocumentsCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-cloudsearch-domain-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-cloudsearch-domain-browser has been renamed to @aws-sdk/client-cloudsearch-domain. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for Amazon CloudSearch Domain","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.5","@aws-sdk/json-parser":"^0.1.0-preview.5","@aws-sdk/core-handler":"^0.1.0-preview.5","@aws-sdk/json-builder":"^0.1.0-preview.5","@aws-sdk/signature-v4":"^0.1.0-preview.7","@aws-sdk/protocol-rest":"^0.1.0-preview.7","@aws-sdk/config-resolver":"^0.1.0-preview.5","@aws-sdk/middleware-stack":"^0.1.0-preview.6","@aws-sdk/retry-middleware":"^0.1.0-preview.5","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.5","@aws-sdk/signing-middleware":"^0.1.0-preview.7","@aws-sdk/url-parser-browser":"^0.1.0-preview.5","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.5","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.6","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.6","@aws-sdk/stream-collector-browser":"^0.1.0-preview.5","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.5","@aws-sdk/middleware-header-default":"^0.1.0-preview.5"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-cloudsearch-domain-browser_0.1.0-preview.3_1568908090809_0.2267885296523784","host":"s3://npm-registry-packages"}},"0.1.0-preview.4":{"name":"@aws-sdk/client-cloudsearch-domain-browser","version":"0.1.0-preview.4","author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","_id":"@aws-sdk/client-cloudsearch-domain-browser@0.1.0-preview.4","maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"}],"dist":{"shasum":"5edcde10208f3dccaccd4221c913dbf8239dea41","tarball":"https://registry.npmjs.org/@aws-sdk/client-cloudsearch-domain-browser/-/client-cloudsearch-domain-browser-0.1.0-preview.4.tgz","fileCount":191,"integrity":"sha512-j22l3sexwCe9IWvJnCCz4IjQan/b+8WF1RxiK3GRQDCF30PGqgEXCMheKuX/L+VaunxE+ozax5It6OT1vhGgMQ==","signatures":[{"sig":"MEUCIQD0Hy1p+snYfpAdzcE0jWddAskHStzxE/lBC0acNRrEhAIgXovGnInLjWT8J6FY7KHUQ28Ls799TKsORv8SuZF/jtk=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":137537,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJduM54CRA9TVsSAnZWagAA2TUQAJGBJBc2u46DXJQ4yus2\nLtO+iFomcZh05/oEVvqc6f6xTK9utzw/O+Z9Oy/5RZ9M9BqSmO2BVulPE4pf\nB/dKRJfD3Ix3WwwqIy5te9547cbXB8gPJ84I4m+B5cHGybuEYESOxfmi/lov\nCAYS9PwldG3pGq1zi0linbiNuRbnz8wIifEKtzinX7+dHYaaMWw6QXlUgK7g\niPC9gCItgr50T/D2t5pDewH2Xa0+63h+QFHnPQzXai+7a//wkFsxsQCi0DkQ\nAQyicoUFI1AmKAl8l1c/V74Snt7PJT6RwPFOG0i4J3ryT9NaMIxAhMY8exHQ\nw9e5eXc87ataiJGSu1XJTgXVqL8cvWR7JuN6J7pfydKC8MyYkLlQFtBzE3kE\nYwwuZiF+bmjGcU+4zi4YkjaAqeUrAZoJVx+n8IxXE/NrmN3I3+kCBmDJH6H5\nRQPD3DsIH2Kp2jFIuDZpDp7A6Tt/a+Sy1eZJVc1dvmAzjlRRcGcdCwo4A+RI\n3VuX1GSp6p5zEatNEwNzVIHli7crhHOkpzPFeKhwQ14+VLnYCxJ3h0/BliZG\nYdk6/WfIwve97WPea9Nf/GeItHtsJValq0jiWxseX8icwqmSUHc1tSMmXdA5\nn6sX9ux5iawHZdlwPrRjBcAFncAjKwRAbjOKXzqE3DxOPVq36hSPedzwVyLS\nh+uJ\r\n=XV7v\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-cloudsearch-domain-browser\n\n[](https://www.npmjs.com/package/@aws-sdk/client-cloudsearch-domain-browser)\n[](https://www.npmjs.com/package/@aws-sdk/client-cloudsearch-domain-browser)\n\n## Description\n\nYou use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents.
The endpoints for submitting UploadDocuments, Search, and Suggest requests are domain-specific. To get the endpoints for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. The domain endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. You submit suggest requests to the search endpoint.
For more information, see the Amazon CloudSearch Developer Guide.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-cloudsearch-domain-browser\n```\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`CloudSearchDomainClient`) and the commands you need, for example `UploadDocumentsCommand`:\n\n```javascript\n//JavaScript\nconst {\n CloudSearchDomainClient,\n UploadDocumentsCommand\n} = require(\"@aws-sdk/client-cloudsearch-domain-browser\");\n```\n\n```javascript\n//TypeScript\nimport {\n CloudSearchDomainClient,\n UploadDocumentsCommand\n} from \"@aws-sdk/client-cloudsearch-domain-browser\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst cloudSearchDomain = new CloudSearchDomainClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n documents: /**a blob value*/\n /**You can supply readable stream to streaming input. e.g. (await fetch(input)).body */,\n contentType: /**a string value*/,\n};\nconst uploadDocumentsCommand = new UploadDocumentsCommand(params);\ncloudSearchDomain.send(uploadDocumentsCommand).then(data => {\n // do something\n}).catch(error => {\n // error handling\n})\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await cloudSearchDomain.send(uploadDocumentsCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\ncloudSearchDomain.send(uploadDocumentsCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/client-cloudsearch-domain-browser\";\nconst cloudSearchDomain = new AWS.CloudSearchDomain({ region: \"region\" });\ncloudSearchDomain.uploadDocuments(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await cloudSearchDomain.send(uploadDocumentsCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-cloudsearch-domain-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-cloudsearch-domain-browser has been renamed to @aws-sdk/client-cloudsearch-domain. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for Amazon CloudSearch Domain","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.6","@aws-sdk/json-parser":"^0.1.0-preview.6","@aws-sdk/core-handler":"^0.1.0-preview.6","@aws-sdk/json-builder":"^0.1.0-preview.6","@aws-sdk/signature-v4":"^0.1.0-preview.8","@aws-sdk/protocol-rest":"^0.1.0-preview.8","@aws-sdk/config-resolver":"^0.1.0-preview.6","@aws-sdk/middleware-stack":"^0.1.0-preview.7","@aws-sdk/retry-middleware":"^0.1.0-preview.6","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.6","@aws-sdk/signing-middleware":"^0.1.0-preview.8","@aws-sdk/url-parser-browser":"^0.1.0-preview.6","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.6","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.7","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.7","@aws-sdk/stream-collector-browser":"^0.1.0-preview.6","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.6","@aws-sdk/middleware-header-default":"^0.1.0-preview.6"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-cloudsearch-domain-browser_0.1.0-preview.4_1572392567668_0.48833683308789766","host":"s3://npm-registry-packages"}},"0.1.0-preview.5":{"name":"@aws-sdk/client-cloudsearch-domain-browser","version":"0.1.0-preview.5","author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","_id":"@aws-sdk/client-cloudsearch-domain-browser@0.1.0-preview.5","maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"}],"dist":{"shasum":"b715dcbef8ccfdeff31b80fc498310da8da125fc","tarball":"https://registry.npmjs.org/@aws-sdk/client-cloudsearch-domain-browser/-/client-cloudsearch-domain-browser-0.1.0-preview.5.tgz","fileCount":191,"integrity":"sha512-PNiHGGEyyBskKJW7zUW1l9IHEndjibw2vzUAsP5su4Mj/XJwx40VGstotog2GtBvPJMdgVk/NI/hRxEKqMOHGA==","signatures":[{"sig":"MEYCIQCr+4CCcNKGvjxO2HK2MfZcN9GzarT+Y+0hfw9mbJ9X/AIhAPUsIq5rT4OK/1M3h9QcE3H0svBM2/yysd2mPy02BuW3","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":137781,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdueFhCRA9TVsSAnZWagAAyhAQAKCKFpGQRkc+xhrqZ4n9\nDAYf74Mgm3+5SsnpLu6qOqjzCaNDk7bv44gP7fh7pkjN9Bgaoc66Z4nYfVMC\nVDMJzDlwd6c4+ZGD8PnaK2rBix9jWRsWXoJXQTFpNZI9GYr5SqNllkhb95AX\nJuvMHDeNAsN3mSK1WZV7Yfl8O3ECFSw/xHMA5aK6bD9ET0JynNrtRX3qJ9g5\nGbfgehUwC0khST15Uh/ol1c2BeWm5XcVaKTeRaKIa8/dVY/xbuF+UpcOtzVd\nNqHU3fxbFKxEXP2uaiwjMKkuXpZ918MIQo2MtlbdjNNcKpTjvg+/Uvwuevp5\no/YVpvCBYJgjEjosNYWj5M28LVg13lYI73dWj4XhgWXeS0ewBb3wN3m8+NWf\nsnjta7xYGSIzeoEqqqPbMW/CePzHhqHGKS1s5gJ+n1rra3VGCT2inMSRb4De\nHNwymVzjTXFzdk+ChRcZH7BPmS+MiFBUJpTmnZsGuYrAlSWMjlTakCVpLhYK\nFlPbelSlw6pu63+gowqxf/5cHvNxsqQDkuP00aIl+RbXM7ZW2rO+EXALMxTb\naWriIB6kVC3AEANK9moMbbKlI5qokRNeb1aUI1ZeKLf/6a90iO+SIBAEJ0dW\n4rbH4eRV5Nl+FVNVE5/ElL44fYGbbSa8ox0YXF5FMrcQZDxaAFraKAHD04vQ\nIt6A\r\n=Crt0\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-cloudsearch-domain-browser\n\n[](https://www.npmjs.com/package/@aws-sdk/client-cloudsearch-domain-browser)\n[](https://www.npmjs.com/package/@aws-sdk/client-cloudsearch-domain-browser)\n\n## Description\n\nYou use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents.
The endpoints for submitting UploadDocuments, Search, and Suggest requests are domain-specific. To get the endpoints for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. The domain endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. You submit suggest requests to the search endpoint.
For more information, see the Amazon CloudSearch Developer Guide.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-cloudsearch-domain-browser\n```\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`CloudSearchDomainClient`) and the commands you need, for example `UploadDocumentsCommand`:\n\n```javascript\n//JavaScript\nconst {\n CloudSearchDomainClient,\n UploadDocumentsCommand\n} = require(\"@aws-sdk/client-cloudsearch-domain-browser\");\n```\n\n```javascript\n//TypeScript\nimport {\n CloudSearchDomainClient,\n UploadDocumentsCommand\n} from \"@aws-sdk/client-cloudsearch-domain-browser\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst cloudSearchDomain = new CloudSearchDomainClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n documents: /**a blob value*/\n /**You can supply readable stream to streaming input. e.g. (await fetch(input)).body */,\n contentType: /**a string value*/,\n};\nconst uploadDocumentsCommand = new UploadDocumentsCommand(params);\ncloudSearchDomain.send(uploadDocumentsCommand).then(data => {\n // do something\n}).catch(error => {\n // error handling\n})\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await cloudSearchDomain.send(uploadDocumentsCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\ncloudSearchDomain.send(uploadDocumentsCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/client-cloudsearch-domain-browser\";\nconst cloudSearchDomain = new AWS.CloudSearchDomain({ region: \"region\" });\ncloudSearchDomain.uploadDocuments(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await cloudSearchDomain.send(uploadDocumentsCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-cloudsearch-domain-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-cloudsearch-domain-browser has been renamed to @aws-sdk/client-cloudsearch-domain. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for Amazon CloudSearch Domain","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.7","@aws-sdk/json-parser":"^0.1.0-preview.7","@aws-sdk/core-handler":"^0.1.0-preview.7","@aws-sdk/json-builder":"^0.1.0-preview.7","@aws-sdk/signature-v4":"^0.1.0-preview.9","@aws-sdk/protocol-rest":"^0.1.0-preview.9","@aws-sdk/config-resolver":"^0.1.0-preview.7","@aws-sdk/middleware-stack":"^0.1.0-preview.8","@aws-sdk/retry-middleware":"^0.1.0-preview.7","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.7","@aws-sdk/signing-middleware":"^0.1.0-preview.9","@aws-sdk/url-parser-browser":"^0.1.0-preview.7","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.7","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.8","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.8","@aws-sdk/stream-collector-browser":"^0.1.0-preview.7","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.7","@aws-sdk/middleware-header-default":"^0.1.0-preview.7"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-cloudsearch-domain-browser_0.1.0-preview.5_1572462944574_0.9045860618783121","host":"s3://npm-registry-packages"}},"0.1.0-preview.6":{"name":"@aws-sdk/client-cloudsearch-domain-browser","version":"0.1.0-preview.6","author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","_id":"@aws-sdk/client-cloudsearch-domain-browser@0.1.0-preview.6","maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"}],"dist":{"shasum":"48e9997cc77f01bf362ba67969f1a2e683807090","tarball":"https://registry.npmjs.org/@aws-sdk/client-cloudsearch-domain-browser/-/client-cloudsearch-domain-browser-0.1.0-preview.6.tgz","fileCount":191,"integrity":"sha512-7Kqtwt/CmcvimBeKx+Orsh15HedKmTPtkTuKQM95iBg8430JQFxxuJZqgAgeQVEuxUlzCEoBNbJoQHLcQ0aQAg==","signatures":[{"sig":"MEUCIQCtLVlPUcqCd7YEcMQxW1Y30hv8x2oafAVJp7Byqs2B9wIgU+GeXXNix7/ySIoODkZTJqMUIXTOpWmsiePk+O9sdmg=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":138052,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd1FMRCRA9TVsSAnZWagAA1o0QAJvTC9QxBUJ1aK5VmOl9\nLsn4QKldw1EBjymg6ELjqa1ZN6KdaNkpCfB0SJnjFMEmrsOWnrQptqz6m3yi\nEx8Z8nSpkWM5phUuWip7xLxdeaniL/BnSAVNpqy491vsNyZ+75ulTJ8heq+3\nZApM+NmBXe4cNZ308lnfP2Q+fCjABf0t78I/EETr9dpZ6AEnJg00Z/CEJac5\n/gkm9keOwLiIqAtC+axP+6w+p+s327GSU2mezGJgHOzHmfkph+545lYwMR3i\neMLHdDfhtg1143dBLUH+qRFL31aGMY+NDzsckuoDMdB/zmFmhk/7Zih8RPyG\nzQFtkdUpRmeZQe/l9/HL3NfeiIgIEwb9CG5JP6re+2llQTshqhpW1LNv6b8t\n05HCD59vZ/d2UDP1B/swIwSfKBWDGwTQTbq0/8dJDEz+V7wwCT/1niWcweiX\nZ6I1IlGD3EtcyUMt23JK9XLrjHhHyTf3eqy1aUaQsqWEmuGxX+g503M75WRZ\n9CHYGK4PWLJ/c5kp5AkSAW6gVNqvm5tROOeSZn2iP2D1ZB7oL6RtpUdiQ4rW\nVD5ZONnXE/7reBlimJ9NjyxAYHOW3OeHItD8MK0HQ14lUYhs/1+JrTluge+u\ngQEP+sfIT1nSV4ep/4lv7Q7qhhackQZIGZ/kehXzsl7s273yPS8iewE0qTj8\nnXr2\r\n=8Scv\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-cloudsearch-domain-browser\n\n[](https://www.npmjs.com/package/@aws-sdk/client-cloudsearch-domain-browser)\n[](https://www.npmjs.com/package/@aws-sdk/client-cloudsearch-domain-browser)\n\n## Description\n\nYou use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents.
The endpoints for submitting UploadDocuments, Search, and Suggest requests are domain-specific. To get the endpoints for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. The domain endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. You submit suggest requests to the search endpoint.
For more information, see the Amazon CloudSearch Developer Guide.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-cloudsearch-domain-browser\n```\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`CloudSearchDomainClient`) and the commands you need, for example `UploadDocumentsCommand`:\n\n```javascript\n//JavaScript\nconst {\n CloudSearchDomainClient,\n UploadDocumentsCommand\n} = require(\"@aws-sdk/client-cloudsearch-domain-browser\");\n```\n\n```javascript\n//TypeScript\nimport {\n CloudSearchDomainClient,\n UploadDocumentsCommand\n} from \"@aws-sdk/client-cloudsearch-domain-browser\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst cloudSearchDomain = new CloudSearchDomainClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n documents: /**a blob value*/\n /**You can supply readable stream to streaming input. e.g. (await fetch(input)).body */,\n contentType: /**a string value*/,\n};\nconst uploadDocumentsCommand = new UploadDocumentsCommand(params);\ncloudSearchDomain.send(uploadDocumentsCommand).then(data => {\n // do something\n}).catch(error => {\n // error handling\n})\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await cloudSearchDomain.send(uploadDocumentsCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\ncloudSearchDomain.send(uploadDocumentsCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/client-cloudsearch-domain-browser\";\nconst cloudSearchDomain = new AWS.CloudSearchDomain({ region: \"region\" });\ncloudSearchDomain.uploadDocuments(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await cloudSearchDomain.send(uploadDocumentsCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-cloudsearch-domain-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-cloudsearch-domain-browser has been renamed to @aws-sdk/client-cloudsearch-domain. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for Amazon CloudSearch Domain","directories":{},"_nodeVersion":"10.16.3","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.7","@aws-sdk/json-parser":"^0.1.0-preview.7","@aws-sdk/core-handler":"^0.1.0-preview.7","@aws-sdk/json-builder":"^0.1.0-preview.7","@aws-sdk/signature-v4":"^0.1.0-preview.10","@aws-sdk/protocol-rest":"^0.1.0-preview.10","@aws-sdk/config-resolver":"^0.1.0-preview.7","@aws-sdk/middleware-stack":"^0.1.0-preview.9","@aws-sdk/retry-middleware":"^0.1.0-preview.7","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.8","@aws-sdk/signing-middleware":"^0.1.0-preview.10","@aws-sdk/url-parser-browser":"^0.1.0-preview.7","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.7","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.8","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.9","@aws-sdk/stream-collector-browser":"^0.1.0-preview.7","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.7","@aws-sdk/middleware-header-default":"^0.1.0-preview.7"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-cloudsearch-domain-browser_0.1.0-preview.6_1574195985198_0.4883132656538143","host":"s3://npm-registry-packages"}}},"time":{"created":"2019-09-09T17:39:38.393Z","modified":"2025-03-27T18:41:06.511Z","0.1.0-preview.2":"2019-09-09T17:39:38.724Z","0.1.0-preview.3":"2019-09-19T15:48:10.969Z","0.1.0-preview.4":"2019-10-29T23:42:47.842Z","0.1.0-preview.5":"2019-10-30T19:15:44.752Z","0.1.0-preview.6":"2019-11-19T20:39:45.371Z"},"author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","description":"Browser SDK for Amazon CloudSearch Domain","maintainers":[{"email":"osa-3p@amazon.com","name":"amzn-oss"},{"email":"aws-sdk-js-automation@amazon.com","name":"aws-sdk-bot"}],"readme":"","readmeFilename":""}