docs(client-servicediscovery): This release adds examples to several Cloud Map actions.

Author: awstools

clients/client-servicediscovery/README.md

@@ -8,12 +8,11 @@ AWS SDK for JavaScript ServiceDiscovery Client for Node.js, Browser and React Na
 
 <fullname>Cloud Map</fullname>
 
-<p>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. </p>
+<p>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. </p>
 
 ## Installing
 

clients/client-servicediscovery/src/ServiceDiscovery.ts

@@ -548,12 +548,11 @@ export interface ServiceDiscovery {
 
 /**
  * <fullname>Cloud Map</fullname>
- *          <p>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. </p>
+ *          <p>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. </p>
  * @public
  */
 export class ServiceDiscovery extends ServiceDiscoveryClient implements ServiceDiscovery {}

clients/client-servicediscovery/src/ServiceDiscoveryClient.ts

@@ -358,12 +358,11 @@ export interface ServiceDiscoveryClientResolvedConfig extends ServiceDiscoveryCl
 
 /**
  * <fullname>Cloud Map</fullname>
- *          <p>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. </p>
+ *          <p>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. </p>
  * @public
  */
 export class ServiceDiscoveryClient extends __Client<

clients/client-servicediscovery/src/commands/CreateHttpNamespaceCommand.ts

@@ -27,11 +27,10 @@ export interface CreateHttpNamespaceCommandInput extends CreateHttpNamespaceRequ
 export interface CreateHttpNamespaceCommandOutput extends CreateHttpNamespaceResponse, __MetadataBearer {}
 
 /**
- * <p>Creates an HTTP namespace. Service instances registered using an HTTP namespace can be
- *    discovered using a <code>DiscoverInstances</code> request but can't be discovered using
- *    DNS.</p>
- *          <p>For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map quotas</a> in the
- *     <i>Cloud Map Developer Guide</i>.</p>
+ * <p>Creates an HTTP namespace. Service instances registered using an HTTP namespace can be discovered using a
+ *     <code>DiscoverInstances</code> request but can't be discovered using DNS.</p>
+ *          <p>For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map
+ *     quotas</a> in the <i>Cloud Map Developer Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -67,20 +66,18 @@ export interface CreateHttpNamespaceCommandOutput extends CreateHttpNamespaceRes
  *  <p>The operation is already in progress.</p>
  *
  * @throws {@link InvalidInput} (client fault)
- *  <p>One or more specified values aren't valid. For example, a required value might be missing, a
- *    numeric value might be outside the allowed range, or a string value might exceed length
- *    constraints.</p>
+ *  <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
+ *    might be outside the allowed range, or a string value might exceed length constraints.</p>
  *
  * @throws {@link NamespaceAlreadyExists} (client fault)
  *  <p>The namespace that you're trying to create already exists.</p>
  *
  * @throws {@link ResourceLimitExceeded} (client fault)
- *  <p>The resource can't be created because you've reached the quota on the number of
- *    resources.</p>
+ *  <p>The resource can't be created because you've reached the quota on the number of resources.</p>
  *
  * @throws {@link TooManyTagsException} (client fault)
- *  <p>The list of tags on the resource is over the quota. The maximum number of tags that can be
- *    applied to a resource is 50.</p>
+ *  <p>The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a
+ *    resource is 50.</p>
  *
  * @throws {@link ServiceDiscoveryServiceException}
  * <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>

clients/client-servicediscovery/src/commands/CreatePrivateDnsNamespaceCommand.ts

@@ -27,13 +27,12 @@ export interface CreatePrivateDnsNamespaceCommandInput extends CreatePrivateDnsN
 export interface CreatePrivateDnsNamespaceCommandOutput extends CreatePrivateDnsNamespaceResponse, __MetadataBearer {}
 
 /**
- * <p>Creates a private namespace based on DNS, which is visible only inside a specified Amazon
- *    VPC. The namespace defines your service naming scheme. For example, if you name your namespace
- *     <code>example.com</code> and name your service <code>backend</code>, the resulting DNS name for
- *    the service is <code>backend.example.com</code>. Service instances that are registered using a
- *    private DNS namespace can be discovered using either a <code>DiscoverInstances</code> request or
- *    using DNS. For the current quota on the number of namespaces that you can create using the same
- *     Amazon Web Services account, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map quotas</a> in the
+ * <p>Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC. The
+ *    namespace defines your service naming scheme. For example, if you name your namespace <code>example.com</code>
+ *    and name your service <code>backend</code>, the resulting DNS name for the service is
+ *     <code>backend.example.com</code>. Service instances that are registered using a private DNS namespace can be
+ *    discovered using either a <code>DiscoverInstances</code> request or using DNS. For the current quota on the
+ *    number of namespaces that you can create using the same Amazon Web Services account, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map quotas</a> in the
  *     <i>Cloud Map Developer Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -78,20 +77,18 @@ export interface CreatePrivateDnsNamespaceCommandOutput extends CreatePrivateDns
  *  <p>The operation is already in progress.</p>
  *
  * @throws {@link InvalidInput} (client fault)
- *  <p>One or more specified values aren't valid. For example, a required value might be missing, a
- *    numeric value might be outside the allowed range, or a string value might exceed length
- *    constraints.</p>
+ *  <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
+ *    might be outside the allowed range, or a string value might exceed length constraints.</p>
  *
  * @throws {@link NamespaceAlreadyExists} (client fault)
  *  <p>The namespace that you're trying to create already exists.</p>
  *
  * @throws {@link ResourceLimitExceeded} (client fault)
- *  <p>The resource can't be created because you've reached the quota on the number of
- *    resources.</p>
+ *  <p>The resource can't be created because you've reached the quota on the number of resources.</p>
  *
  * @throws {@link TooManyTagsException} (client fault)
- *  <p>The list of tags on the resource is over the quota. The maximum number of tags that can be
- *    applied to a resource is 50.</p>
+ *  <p>The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a
+ *    resource is 50.</p>
  *
  * @throws {@link ServiceDiscoveryServiceException}
  * <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>

clients/client-servicediscovery/src/commands/CreatePublicDnsNamespaceCommand.ts

@@ -27,15 +27,16 @@ export interface CreatePublicDnsNamespaceCommandInput extends CreatePublicDnsNam
 export interface CreatePublicDnsNamespaceCommandOutput extends CreatePublicDnsNamespaceResponse, __MetadataBearer {}
 
 /**
- * <p>Creates a public namespace based on DNS, which is visible on the internet. The namespace
- *    defines your service naming scheme. For example, if you name your namespace
- *     <code>example.com</code> and name your service <code>backend</code>, the resulting DNS name for
- *    the service is <code>backend.example.com</code>. You can discover instances that were registered
- *    with a public DNS namespace by using either a <code>DiscoverInstances</code> request or using
- *    DNS. For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map quotas</a> in the
+ * <p>Creates a public namespace based on DNS, which is visible on the internet. The namespace defines your
+ *    service naming scheme. For example, if you name your namespace <code>example.com</code> and name your service
+ *     <code>backend</code>, the resulting DNS name for the service is <code>backend.example.com</code>. You can
+ *    discover instances that were registered with a public DNS namespace by using either a
+ *     <code>DiscoverInstances</code> request or using DNS. For the current quota on the number of namespaces that you
+ *    can create using the same Amazon Web Services account, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map quotas</a> in the
  *     <i>Cloud Map Developer Guide</i>.</p>
  *          <important>
- *             <p>The <code>CreatePublicDnsNamespace</code> API operation is not supported in the Amazon Web Services GovCloud (US) Regions.</p>
+ *             <p>The <code>CreatePublicDnsNamespace</code> API operation is not supported in the Amazon Web Services GovCloud (US)
+ *     Regions.</p>
  *          </important>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -79,20 +80,18 @@ export interface CreatePublicDnsNamespaceCommandOutput extends CreatePublicDnsNa
  *  <p>The operation is already in progress.</p>
  *
  * @throws {@link InvalidInput} (client fault)
- *  <p>One or more specified values aren't valid. For example, a required value might be missing, a
- *    numeric value might be outside the allowed range, or a string value might exceed length
- *    constraints.</p>
+ *  <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
+ *    might be outside the allowed range, or a string value might exceed length constraints.</p>
  *
  * @throws {@link NamespaceAlreadyExists} (client fault)
  *  <p>The namespace that you're trying to create already exists.</p>
  *
  * @throws {@link ResourceLimitExceeded} (client fault)
- *  <p>The resource can't be created because you've reached the quota on the number of
- *    resources.</p>
+ *  <p>The resource can't be created because you've reached the quota on the number of resources.</p>
  *
  * @throws {@link TooManyTagsException} (client fault)
- *  <p>The list of tags on the resource is over the quota. The maximum number of tags that can be
- *    applied to a resource is 50.</p>
+ *  <p>The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a
+ *    resource is 50.</p>
  *
  * @throws {@link ServiceDiscoveryServiceException}
  * <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>

clients/client-servicediscovery/src/commands/CreateServiceCommand.ts

@@ -64,11 +64,11 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
  *                <p>Optionally, a health check</p>
  *             </li>
  *          </ul>
- *          <p>After you create the service, you can submit a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html">RegisterInstance</a> request, and
- *    Cloud Map uses the values in the configuration to create the specified entities.</p>
- *          <p>For the current quota on the number of instances that you can register using the same
- *    namespace and using the same service, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map quotas</a> in the
- *     <i>Cloud Map Developer Guide</i>.</p>
+ *          <p>After you create the service, you can submit a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html">RegisterInstance</a> request, and Cloud Map uses the
+ *    values in the configuration to create the specified entities.</p>
+ *          <p>For the current quota on the number of instances that you can register using the same namespace and using
+ *    the same service, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map
+ *     quotas</a> in the <i>Cloud Map Developer Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -149,23 +149,21 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
  *
  * @throws {@link InvalidInput} (client fault)
- *  <p>One or more specified values aren't valid. For example, a required value might be missing, a
- *    numeric value might be outside the allowed range, or a string value might exceed length
- *    constraints.</p>
+ *  <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
+ *    might be outside the allowed range, or a string value might exceed length constraints.</p>
  *
  * @throws {@link NamespaceNotFound} (client fault)
  *  <p>No namespace exists with the specified ID.</p>
  *
  * @throws {@link ResourceLimitExceeded} (client fault)
- *  <p>The resource can't be created because you've reached the quota on the number of
- *    resources.</p>
+ *  <p>The resource can't be created because you've reached the quota on the number of resources.</p>
  *
  * @throws {@link ServiceAlreadyExists} (client fault)
  *  <p>The service can't be created because a service with the same name already exists.</p>
  *
  * @throws {@link TooManyTagsException} (client fault)
- *  <p>The list of tags on the resource is over the quota. The maximum number of tags that can be
- *    applied to a resource is 50.</p>
+ *  <p>The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a
+ *    resource is 50.</p>
  *
  * @throws {@link ServiceDiscoveryServiceException}
  * <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>

clients/client-servicediscovery/src/commands/DeleteNamespaceCommand.ts

@@ -27,8 +27,8 @@ export interface DeleteNamespaceCommandInput extends DeleteNamespaceRequest {}
 export interface DeleteNamespaceCommandOutput extends DeleteNamespaceResponse, __MetadataBearer {}
 
 /**
- * <p>Deletes a namespace from the current account. If the namespace still contains one or more
- *    services, the request fails.</p>
+ * <p>Deletes a namespace from the current account. If the namespace still contains one or more services, the
+ *    request fails.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -56,16 +56,15 @@ export interface DeleteNamespaceCommandOutput extends DeleteNamespaceResponse, _
  *  <p>The operation is already in progress.</p>
  *
  * @throws {@link InvalidInput} (client fault)
- *  <p>One or more specified values aren't valid. For example, a required value might be missing, a
- *    numeric value might be outside the allowed range, or a string value might exceed length
- *    constraints.</p>
+ *  <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
+ *    might be outside the allowed range, or a string value might exceed length constraints.</p>
  *
  * @throws {@link NamespaceNotFound} (client fault)
  *  <p>No namespace exists with the specified ID.</p>
  *
  * @throws {@link ResourceInUse} (client fault)
- *  <p>The specified resource can't be deleted because it contains other resources. For example,
- *    you can't delete a service that contains any instances.</p>
+ *  <p>The specified resource can't be deleted because it contains other resources. For example, you can't delete
+ *    a service that contains any instances.</p>
  *
  * @throws {@link ServiceDiscoveryServiceException}
  * <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>

clients/client-servicediscovery/src/commands/DeleteServiceCommand.ts

@@ -27,8 +27,8 @@ export interface DeleteServiceCommandInput extends DeleteServiceRequest {}
 export interface DeleteServiceCommandOutput extends DeleteServiceResponse, __MetadataBearer {}
 
 /**
- * <p>Deletes a specified service. If the service still contains one or more registered instances,
- *    the request fails.</p>
+ * <p>Deletes a specified service. If the service still contains one or more registered instances, the request
+ *    fails.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -51,13 +51,12 @@ export interface DeleteServiceCommandOutput extends DeleteServiceResponse, __Met
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
  *
  * @throws {@link InvalidInput} (client fault)
- *  <p>One or more specified values aren't valid. For example, a required value might be missing, a
- *    numeric value might be outside the allowed range, or a string value might exceed length
- *    constraints.</p>
+ *  <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
+ *    might be outside the allowed range, or a string value might exceed length constraints.</p>
  *
  * @throws {@link ResourceInUse} (client fault)
- *  <p>The specified resource can't be deleted because it contains other resources. For example,
- *    you can't delete a service that contains any instances.</p>
+ *  <p>The specified resource can't be deleted because it contains other resources. For example, you can't delete
+ *    a service that contains any instances.</p>
  *
  * @throws {@link ServiceNotFound} (client fault)
  *  <p>No service exists with the specified ID.</p>