AWS SDK for JavaScript Servicediscovery Client for Node.js, Browser and React Native
npm install @aws-sdk/client-servicediscoveryAWS SDK for JavaScript ServiceDiscovery Client for Node.js, Browser and React Native.
With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your
microservice applications run in. When an instance becomes available, you can call the Cloud Map
API to register the instance with Cloud Map. For public or private DNS namespaces, Cloud Map
automatically creates DNS records and an optional health check. Clients that submit public or
private DNS queries, or HTTP requests, for the service receive an answer that contains up to
eight healthy records.
npm install @aws-sdk/client-servicediscoveryyarn add @aws-sdk/client-servicediscoverypnpm add @aws-sdk/client-servicediscoveryThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the ServiceDiscoveryClient and
the commands you need, for example ListNamespacesCommand:
``js`
// ES5 example
const { ServiceDiscoveryClient, ListNamespacesCommand } = require("@aws-sdk/client-servicediscovery");
`ts`
// ES6+ example
import { ServiceDiscoveryClient, ListNamespacesCommand } from "@aws-sdk/client-servicediscovery";
To send a request, you:
- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.destroy()
- If you are using a custom http handler, you may call to close open connections.
`js
// a client can be shared by different commands.
const client = new ServiceDiscoveryClient({ region: "REGION" });
const params = { /* input parameters / };
const command = new ListNamespacesCommand(params);
`
#### Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
`js`
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.
#### Promises
You can also use Promise chaining
to execute send operation.
`js`
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
`js`
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
#### Callbacks
We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.
`js`
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
#### v2 compatible style
The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript
`ts
import * as AWS from "@aws-sdk/client-servicediscovery";
const client = new AWS.ServiceDiscovery({ region: "REGION" });
// async/await.
try {
const data = await client.listNamespaces(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listNamespaces(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listNamespaces(params, (err, data) => {
// process err and data.
});
`
When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).
`js`
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.
To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-servicediscovery` package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.
CreateHttpNamespace
Command API Reference / Input / Output
CreatePrivateDnsNamespace
Command API Reference / Input / Output
CreatePublicDnsNamespace
Command API Reference / Input / Output
CreateService
Command API Reference / Input / Output
DeleteNamespace
Command API Reference / Input / Output
DeleteService
Command API Reference / Input / Output
DeleteServiceAttributes
Command API Reference / Input / Output
DeregisterInstance
Command API Reference / Input / Output
DiscoverInstances
Command API Reference / Input / Output
DiscoverInstancesRevision
Command API Reference / Input / Output
GetInstance
Command API Reference / Input / Output
GetInstancesHealthStatus
Command API Reference / Input / Output
GetNamespace
Command API Reference / Input / Output
GetOperation
Command API Reference / Input / Output
GetService
Command API Reference / Input / Output
GetServiceAttributes
Command API Reference / Input / Output
ListInstances
Command API Reference / Input / Output
ListNamespaces
Command API Reference / Input / Output
ListOperations
Command API Reference / Input / Output
ListServices
Command API Reference / Input / Output
ListTagsForResource
Command API Reference / Input / Output
RegisterInstance
Command API Reference / Input / Output
TagResource
Command API Reference / Input / Output
UntagResource
Command API Reference / Input / Output
UpdateHttpNamespace
Command API Reference / Input / Output
UpdateInstanceCustomHealthStatus
Command API Reference / Input / Output
UpdatePrivateDnsNamespace
Command API Reference / Input / Output
UpdatePublicDnsNamespace
Command API Reference / Input / Output
UpdateService
Command API Reference / Input / Output
UpdateServiceAttributes