@aws-sdk/client-servicediscovery 3.556.0 → 3.561.0

package/dist-types/commands/RegisterInstanceCommand.d.ts

@@ -26,50 +26,46 @@ declare const RegisterInstanceCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Creates or updates one or more records and, optionally, creates a health check based on the
- *    settings in a specified service. When you submit a <code>RegisterInstance</code> request, the
- *    following occurs:</p>
+ * <p>Creates or updates one or more records and, optionally, creates a health check based on the settings in a
+ *    specified service. When you submit a <code>RegisterInstance</code> request, the following occurs:</p>
  *          <ul>
  *             <li>
- *                <p>For each DNS record that you define in the service that's specified by
- *       <code>ServiceId</code>, a record is created or updated in the hosted zone that's associated
- *      with the corresponding namespace.</p>
+ *                <p>For each DNS record that you define in the service that's specified by <code>ServiceId</code>, a record
+ *      is created or updated in the hosted zone that's associated with the corresponding namespace.</p>
  *             </li>
  *             <li>
- *                <p>If the service includes <code>HealthCheckConfig</code>, a health check is created based on
- *      the settings in the health check configuration.</p>
+ *                <p>If the service includes <code>HealthCheckConfig</code>, a health check is created based on the settings
+ *      in the health check configuration.</p>
  *             </li>
  *             <li>
  *                <p>The health check, if any, is associated with each of the new or updated records.</p>
  *             </li>
  *          </ul>
  *          <important>
- *             <p>One <code>RegisterInstance</code> request must complete before you can submit another
- *     request and specify the same service ID and instance ID.</p>
+ *             <p>One <code>RegisterInstance</code> request must complete before you can submit another request and specify
+ *     the same service ID and instance ID.</p>
  *          </important>
  *          <p>For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html">CreateService</a>.</p>
- *          <p>When Cloud Map receives a DNS query for the specified DNS name, it returns the applicable
- *    value:</p>
+ *          <p>When Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value:</p>
  *          <ul>
  *             <li>
  *                <p>
- *                   <b>If the health check is healthy</b>: returns all the
- *      records</p>
+ *                   <b>If the health check is healthy</b>: returns all the records</p>
  *             </li>
  *             <li>
  *                <p>
- *                   <b>If the health check is unhealthy</b>: returns the applicable
- *      value for the last healthy instance</p>
+ *                   <b>If the health check is unhealthy</b>: returns the applicable value for the
+ *      last healthy instance</p>
  *             </li>
  *             <li>
  *                <p>
- *                   <b>If you didn't specify a health check configuration</b>:
- *      returns all the records</p>
+ *                   <b>If you didn't specify a health check configuration</b>: returns all the
+ *      records</p>
  *             </li>
  *          </ul>
- *          <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>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
@@ -102,17 +98,15 @@ declare const RegisterInstanceCommand_base: {
  *  <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 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 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 ServiceNotFound} (client fault)
  *  <p>No service exists with the specified ID.</p>

package/dist-types/commands/TagResourceCommand.d.ts

@@ -55,16 +55,15 @@ declare const TagResourceCommand_base: {
  * @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 ResourceNotFoundException} (client fault)
  *  <p>The operation can't be completed because the resource was not found.</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>

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -52,9 +52,8 @@ declare const UntagResourceCommand_base: {
  * @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 ResourceNotFoundException} (client fault)
  *  <p>The operation can't be completed because the resource was not found.</p>

package/dist-types/commands/UpdateHttpNamespaceCommand.d.ts

@@ -59,21 +59,39 @@ declare const UpdateHttpNamespaceCommand_base: {
  *  <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>
  *
  * @public
+ * @example To update a HTTP namespace
+ * ```javascript
+ * // The following example updates the description of a HTTP namespace.
+ * const input = {
+ *   "Id": "ns-vh4nbmEXAMPLE",
+ *   "Namespace": {
+ *     "Description": "The updated namespace description."
+ *   }
+ * };
+ * const command = new UpdateHttpNamespaceCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "OperationId": "ft52xe2koxhoeormaceymagglsdjyvEXAMPLE"
+ * }
+ * *\/
+ * // example id: to-update-a-http-namespace-17128EXAMPLE
+ * ```
+ *
  */
 export declare class UpdateHttpNamespaceCommand extends UpdateHttpNamespaceCommand_base {
 }

package/dist-types/commands/UpdateInstanceCustomHealthStatusCommand.d.ts

@@ -26,12 +26,10 @@ declare const UpdateInstanceCustomHealthStatusCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Submits a request to change the health status of a custom health check to healthy or
- *    unhealthy.</p>
- *          <p>You can use <code>UpdateInstanceCustomHealthStatus</code> to change the status only for
- *    custom health checks, which you define using <code>HealthCheckCustomConfig</code> when you create
- *    a service. You can't use it to change the status for Route 53 health checks, which you define using
- *     <code>HealthCheckConfig</code>.</p>
+ * <p>Submits a request to change the health status of a custom health check to healthy or unhealthy.</p>
+ *          <p>You can use <code>UpdateInstanceCustomHealthStatus</code> to change the status only for custom health
+ *    checks, which you define using <code>HealthCheckCustomConfig</code> when you create a service. You can't use it
+ *    to change the status for Route 53 health checks, which you define using <code>HealthCheckConfig</code>.</p>
  *          <p>For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_HealthCheckCustomConfig.html">HealthCheckCustomConfig</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -57,17 +55,16 @@ declare const UpdateInstanceCustomHealthStatusCommand_base: {
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
  *
  * @throws {@link CustomHealthNotFound} (client fault)
- *  <p>The health check for the instance that's specified by <code>ServiceId</code> and
- *     <code>InstanceId</code> isn't a custom health check. </p>
+ *  <p>The health check for the instance that's specified by <code>ServiceId</code> and <code>InstanceId</code>
+ *    isn't a custom health check. </p>
  *
  * @throws {@link InstanceNotFound} (client fault)
- *  <p>No instance exists with the specified ID, or the instance was recently registered, and
- *    information about the instance hasn't propagated yet.</p>
+ *  <p>No instance exists with the specified ID, or the instance was recently registered, and information about
+ *    the instance hasn't propagated yet.</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 ServiceNotFound} (client fault)
  *  <p>No service exists with the specified ID.</p>

package/dist-types/commands/UpdatePrivateDnsNamespaceCommand.d.ts

@@ -66,21 +66,60 @@ declare const UpdatePrivateDnsNamespaceCommand_base: {
  *  <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>
  *
  * @public
+ * @example To update a private DNS namespace
+ * ```javascript
+ * // The following example updates the description of a private DNS namespace.
+ * const input = {
+ *   "Id": "ns-bk3aEXAMPLE",
+ *   "Namespace": {
+ *     "Description": "The updated namespace description."
+ *   },
+ *   "UpdaterRequestId": ""
+ * };
+ * const command = new UpdatePrivateDnsNamespaceCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "OperationId": "ft52xe2koxhoeormaceymagglsdjyvEXAMPLE"
+ * }
+ * *\/
+ * // example id: to-update-a-private-dns-namespace-1712868389604
+ * ```
+ *
+ * @example To update a public DNS namespace
+ * ```javascript
+ * // The following example updates the description of a public DNS namespace.
+ * const input = {
+ *   "Id": "ns-bk3aEXAMPLE",
+ *   "Namespace": {
+ *     "Description": "The updated namespace description."
+ *   },
+ *   "UpdaterRequestId": ""
+ * };
+ * const command = new UpdatePrivateDnsNamespaceCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "OperationId": "ft52xe2koxhoeormaceymagglsdjEXAMPLE"
+ * }
+ * *\/
+ * // example id: to-update-a-public-dns-namespace-1712868389604
+ * ```
+ *
  */
 export declare class UpdatePrivateDnsNamespaceCommand extends UpdatePrivateDnsNamespaceCommand_base {
 }

package/dist-types/commands/UpdatePublicDnsNamespaceCommand.d.ts

@@ -66,16 +66,15 @@ declare const UpdatePublicDnsNamespaceCommand_base: {
  *  <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>

package/dist-types/commands/UpdateServiceCommand.d.ts

@@ -34,25 +34,23 @@ declare const UpdateServiceCommand_base: {
  *             <li>
  *                <p>Add, update, or delete <code>HealthCheckConfig</code> for a specified service</p>
  *                <note>
- *                   <p>You can't add, update, or delete a <code>HealthCheckCustomConfig</code>
- *       configuration.</p>
+ *                   <p>You can't add, update, or delete a <code>HealthCheckCustomConfig</code> configuration.</p>
  *                </note>
  *             </li>
  *          </ul>
  *          <p>For public and private DNS namespaces, note the following:</p>
  *          <ul>
  *             <li>
- *                <p>If you omit any existing <code>DnsRecords</code> or <code>HealthCheckConfig</code>
- *      configurations from an <code>UpdateService</code> request, the configurations are deleted from
- *      the service.</p>
+ *                <p>If you omit any existing <code>DnsRecords</code> or <code>HealthCheckConfig</code> configurations from an
+ *       <code>UpdateService</code> request, the configurations are deleted from the service.</p>
  *             </li>
  *             <li>
  *                <p>If you omit an existing <code>HealthCheckCustomConfig</code> configuration from an
  *       <code>UpdateService</code> request, the configuration isn't deleted from the service.</p>
  *             </li>
  *          </ul>
- *          <p>When you update settings for a service, Cloud Map also updates the corresponding settings
- *    in all the records and health checks that were created by using the specified service.</p>
+ *          <p>When you update settings for a service, Cloud Map also updates the corresponding settings in all the
+ *    records and health checks that were created by using the specified service.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -96,9 +94,8 @@ declare const UpdateServiceCommand_base: {
  *  <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 ServiceNotFound} (client fault)
  *  <p>No service exists with the specified ID.</p>

package/dist-types/index.d.ts

@@ -1,11 +1,10 @@
 /**
  * <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>
  *
  * @packageDocumentation
  */