@aws-sdk/client-servicediscovery 3.556.0 → 3.560.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. package/README.md +5 -6
  2. package/dist-types/ServiceDiscovery.d.ts +5 -6
  3. package/dist-types/ServiceDiscoveryClient.d.ts +5 -6
  4. package/dist-types/commands/CreateHttpNamespaceCommand.d.ts +9 -12
  5. package/dist-types/commands/CreatePrivateDnsNamespaceCommand.d.ts +11 -14
  6. package/dist-types/commands/CreatePublicDnsNamespaceCommand.d.ts +13 -14
  7. package/dist-types/commands/CreateServiceCommand.d.ts +10 -12
  8. package/dist-types/commands/DeleteNamespaceCommand.d.ts +6 -7
  9. package/dist-types/commands/DeleteServiceCommand.d.ts +6 -7
  10. package/dist-types/commands/DeregisterInstanceCommand.d.ts +8 -9
  11. package/dist-types/commands/DiscoverInstancesCommand.d.ts +8 -10
  12. package/dist-types/commands/DiscoverInstancesRevisionCommand.d.ts +5 -6
  13. package/dist-types/commands/GetInstanceCommand.d.ts +4 -5
  14. package/dist-types/commands/GetInstancesHealthStatusCommand.d.ts +8 -10
  15. package/dist-types/commands/GetNamespaceCommand.d.ts +2 -3
  16. package/dist-types/commands/GetOperationCommand.d.ts +2 -3
  17. package/dist-types/commands/GetServiceCommand.d.ts +2 -3
  18. package/dist-types/commands/ListInstancesCommand.d.ts +3 -5
  19. package/dist-types/commands/ListNamespacesCommand.d.ts +2 -3
  20. package/dist-types/commands/ListOperationsCommand.d.ts +2 -3
  21. package/dist-types/commands/ListServicesCommand.d.ts +3 -4
  22. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -3
  23. package/dist-types/commands/RegisterInstanceCommand.d.ts +22 -28
  24. package/dist-types/commands/TagResourceCommand.d.ts +4 -5
  25. package/dist-types/commands/UntagResourceCommand.d.ts +2 -3
  26. package/dist-types/commands/UpdateHttpNamespaceCommand.d.ts +4 -5
  27. package/dist-types/commands/UpdateInstanceCustomHealthStatusCommand.d.ts +10 -13
  28. package/dist-types/commands/UpdatePrivateDnsNamespaceCommand.d.ts +4 -5
  29. package/dist-types/commands/UpdatePublicDnsNamespaceCommand.d.ts +4 -5
  30. package/dist-types/commands/UpdateServiceCommand.d.ts +7 -10
  31. package/dist-types/index.d.ts +5 -6
  32. package/dist-types/models/models_0.d.ts +670 -741
  33. package/package.json +1 -1
@@ -26,50 +26,46 @@ declare const RegisterInstanceCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>Creates or updates one or more records and, optionally, creates a health check based on the
30
- * settings in a specified service. When you submit a <code>RegisterInstance</code> request, the
31
- * following occurs:</p>
29
+ * <p>Creates or updates one or more records and, optionally, creates a health check based on the settings in a
30
+ * specified service. When you submit a <code>RegisterInstance</code> request, the following occurs:</p>
32
31
  * <ul>
33
32
  * <li>
34
- * <p>For each DNS record that you define in the service that's specified by
35
- * <code>ServiceId</code>, a record is created or updated in the hosted zone that's associated
36
- * with the corresponding namespace.</p>
33
+ * <p>For each DNS record that you define in the service that's specified by <code>ServiceId</code>, a record
34
+ * is created or updated in the hosted zone that's associated with the corresponding namespace.</p>
37
35
  * </li>
38
36
  * <li>
39
- * <p>If the service includes <code>HealthCheckConfig</code>, a health check is created based on
40
- * the settings in the health check configuration.</p>
37
+ * <p>If the service includes <code>HealthCheckConfig</code>, a health check is created based on the settings
38
+ * in the health check configuration.</p>
41
39
  * </li>
42
40
  * <li>
43
41
  * <p>The health check, if any, is associated with each of the new or updated records.</p>
44
42
  * </li>
45
43
  * </ul>
46
44
  * <important>
47
- * <p>One <code>RegisterInstance</code> request must complete before you can submit another
48
- * request and specify the same service ID and instance ID.</p>
45
+ * <p>One <code>RegisterInstance</code> request must complete before you can submit another request and specify
46
+ * the same service ID and instance ID.</p>
49
47
  * </important>
50
48
  * <p>For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html">CreateService</a>.</p>
51
- * <p>When Cloud Map receives a DNS query for the specified DNS name, it returns the applicable
52
- * value:</p>
49
+ * <p>When Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value:</p>
53
50
  * <ul>
54
51
  * <li>
55
52
  * <p>
56
- * <b>If the health check is healthy</b>: returns all the
57
- * records</p>
53
+ * <b>If the health check is healthy</b>: returns all the records</p>
58
54
  * </li>
59
55
  * <li>
60
56
  * <p>
61
- * <b>If the health check is unhealthy</b>: returns the applicable
62
- * value for the last healthy instance</p>
57
+ * <b>If the health check is unhealthy</b>: returns the applicable value for the
58
+ * last healthy instance</p>
63
59
  * </li>
64
60
  * <li>
65
61
  * <p>
66
- * <b>If you didn't specify a health check configuration</b>:
67
- * returns all the records</p>
62
+ * <b>If you didn't specify a health check configuration</b>: returns all the
63
+ * records</p>
68
64
  * </li>
69
65
  * </ul>
70
- * <p>For the current quota on the number of instances that you can register using the same
71
- * 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
72
- * <i>Cloud Map Developer Guide</i>.</p>
66
+ * <p>For the current quota on the number of instances that you can register using the same namespace and using
67
+ * the same service, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map
68
+ * quotas</a> in the <i>Cloud Map Developer Guide</i>.</p>
73
69
  * @example
74
70
  * Use a bare-bones client and the command you need to make an API call.
75
71
  * ```javascript
@@ -102,17 +98,15 @@ declare const RegisterInstanceCommand_base: {
102
98
  * <p>The operation is already in progress.</p>
103
99
  *
104
100
  * @throws {@link InvalidInput} (client fault)
105
- * <p>One or more specified values aren't valid. For example, a required value might be missing, a
106
- * numeric value might be outside the allowed range, or a string value might exceed length
107
- * constraints.</p>
101
+ * <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
102
+ * might be outside the allowed range, or a string value might exceed length constraints.</p>
108
103
  *
109
104
  * @throws {@link ResourceInUse} (client fault)
110
- * <p>The specified resource can't be deleted because it contains other resources. For example,
111
- * you can't delete a service that contains any instances.</p>
105
+ * <p>The specified resource can't be deleted because it contains other resources. For example, you can't delete
106
+ * a service that contains any instances.</p>
112
107
  *
113
108
  * @throws {@link ResourceLimitExceeded} (client fault)
114
- * <p>The resource can't be created because you've reached the quota on the number of
115
- * resources.</p>
109
+ * <p>The resource can't be created because you've reached the quota on the number of resources.</p>
116
110
  *
117
111
  * @throws {@link ServiceNotFound} (client fault)
118
112
  * <p>No service exists with the specified ID.</p>
@@ -55,16 +55,15 @@ declare const TagResourceCommand_base: {
55
55
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
56
56
  *
57
57
  * @throws {@link InvalidInput} (client fault)
58
- * <p>One or more specified values aren't valid. For example, a required value might be missing, a
59
- * numeric value might be outside the allowed range, or a string value might exceed length
60
- * constraints.</p>
58
+ * <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
59
+ * might be outside the allowed range, or a string value might exceed length constraints.</p>
61
60
  *
62
61
  * @throws {@link ResourceNotFoundException} (client fault)
63
62
  * <p>The operation can't be completed because the resource was not found.</p>
64
63
  *
65
64
  * @throws {@link TooManyTagsException} (client fault)
66
- * <p>The list of tags on the resource is over the quota. The maximum number of tags that can be
67
- * applied to a resource is 50.</p>
65
+ * <p>The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a
66
+ * resource is 50.</p>
68
67
  *
69
68
  * @throws {@link ServiceDiscoveryServiceException}
70
69
  * <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>
@@ -52,9 +52,8 @@ declare const UntagResourceCommand_base: {
52
52
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
53
53
  *
54
54
  * @throws {@link InvalidInput} (client fault)
55
- * <p>One or more specified values aren't valid. For example, a required value might be missing, a
56
- * numeric value might be outside the allowed range, or a string value might exceed length
57
- * constraints.</p>
55
+ * <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
56
+ * might be outside the allowed range, or a string value might exceed length constraints.</p>
58
57
  *
59
58
  * @throws {@link ResourceNotFoundException} (client fault)
60
59
  * <p>The operation can't be completed because the resource was not found.</p>
@@ -59,16 +59,15 @@ declare const UpdateHttpNamespaceCommand_base: {
59
59
  * <p>The operation is already in progress.</p>
60
60
  *
61
61
  * @throws {@link InvalidInput} (client fault)
62
- * <p>One or more specified values aren't valid. For example, a required value might be missing, a
63
- * numeric value might be outside the allowed range, or a string value might exceed length
64
- * constraints.</p>
62
+ * <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
63
+ * might be outside the allowed range, or a string value might exceed length constraints.</p>
65
64
  *
66
65
  * @throws {@link NamespaceNotFound} (client fault)
67
66
  * <p>No namespace exists with the specified ID.</p>
68
67
  *
69
68
  * @throws {@link ResourceInUse} (client fault)
70
- * <p>The specified resource can't be deleted because it contains other resources. For example,
71
- * you can't delete a service that contains any instances.</p>
69
+ * <p>The specified resource can't be deleted because it contains other resources. For example, you can't delete
70
+ * a service that contains any instances.</p>
72
71
  *
73
72
  * @throws {@link ServiceDiscoveryServiceException}
74
73
  * <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>
@@ -26,12 +26,10 @@ declare const UpdateInstanceCustomHealthStatusCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>Submits a request to change the health status of a custom health check to healthy or
30
- * unhealthy.</p>
31
- * <p>You can use <code>UpdateInstanceCustomHealthStatus</code> to change the status only for
32
- * custom health checks, which you define using <code>HealthCheckCustomConfig</code> when you create
33
- * a service. You can't use it to change the status for Route 53 health checks, which you define using
34
- * <code>HealthCheckConfig</code>.</p>
29
+ * <p>Submits a request to change the health status of a custom health check to healthy or unhealthy.</p>
30
+ * <p>You can use <code>UpdateInstanceCustomHealthStatus</code> to change the status only for custom health
31
+ * checks, which you define using <code>HealthCheckCustomConfig</code> when you create a service. You can't use it
32
+ * to change the status for Route 53 health checks, which you define using <code>HealthCheckConfig</code>.</p>
35
33
  * <p>For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_HealthCheckCustomConfig.html">HealthCheckCustomConfig</a>.</p>
36
34
  * @example
37
35
  * Use a bare-bones client and the command you need to make an API call.
@@ -57,17 +55,16 @@ declare const UpdateInstanceCustomHealthStatusCommand_base: {
57
55
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
58
56
  *
59
57
  * @throws {@link CustomHealthNotFound} (client fault)
60
- * <p>The health check for the instance that's specified by <code>ServiceId</code> and
61
- * <code>InstanceId</code> isn't a custom health check. </p>
58
+ * <p>The health check for the instance that's specified by <code>ServiceId</code> and <code>InstanceId</code>
59
+ * isn't a custom health check. </p>
62
60
  *
63
61
  * @throws {@link InstanceNotFound} (client fault)
64
- * <p>No instance exists with the specified ID, or the instance was recently registered, and
65
- * information about the instance hasn't propagated yet.</p>
62
+ * <p>No instance exists with the specified ID, or the instance was recently registered, and information about
63
+ * the instance hasn't propagated yet.</p>
66
64
  *
67
65
  * @throws {@link InvalidInput} (client fault)
68
- * <p>One or more specified values aren't valid. For example, a required value might be missing, a
69
- * numeric value might be outside the allowed range, or a string value might exceed length
70
- * constraints.</p>
66
+ * <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
67
+ * might be outside the allowed range, or a string value might exceed length constraints.</p>
71
68
  *
72
69
  * @throws {@link ServiceNotFound} (client fault)
73
70
  * <p>No service exists with the specified ID.</p>
@@ -66,16 +66,15 @@ declare const UpdatePrivateDnsNamespaceCommand_base: {
66
66
  * <p>The operation is already in progress.</p>
67
67
  *
68
68
  * @throws {@link InvalidInput} (client fault)
69
- * <p>One or more specified values aren't valid. For example, a required value might be missing, a
70
- * numeric value might be outside the allowed range, or a string value might exceed length
71
- * constraints.</p>
69
+ * <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
70
+ * might be outside the allowed range, or a string value might exceed length constraints.</p>
72
71
  *
73
72
  * @throws {@link NamespaceNotFound} (client fault)
74
73
  * <p>No namespace exists with the specified ID.</p>
75
74
  *
76
75
  * @throws {@link ResourceInUse} (client fault)
77
- * <p>The specified resource can't be deleted because it contains other resources. For example,
78
- * you can't delete a service that contains any instances.</p>
76
+ * <p>The specified resource can't be deleted because it contains other resources. For example, you can't delete
77
+ * a service that contains any instances.</p>
79
78
  *
80
79
  * @throws {@link ServiceDiscoveryServiceException}
81
80
  * <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>
@@ -66,16 +66,15 @@ declare const UpdatePublicDnsNamespaceCommand_base: {
66
66
  * <p>The operation is already in progress.</p>
67
67
  *
68
68
  * @throws {@link InvalidInput} (client fault)
69
- * <p>One or more specified values aren't valid. For example, a required value might be missing, a
70
- * numeric value might be outside the allowed range, or a string value might exceed length
71
- * constraints.</p>
69
+ * <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
70
+ * might be outside the allowed range, or a string value might exceed length constraints.</p>
72
71
  *
73
72
  * @throws {@link NamespaceNotFound} (client fault)
74
73
  * <p>No namespace exists with the specified ID.</p>
75
74
  *
76
75
  * @throws {@link ResourceInUse} (client fault)
77
- * <p>The specified resource can't be deleted because it contains other resources. For example,
78
- * you can't delete a service that contains any instances.</p>
76
+ * <p>The specified resource can't be deleted because it contains other resources. For example, you can't delete
77
+ * a service that contains any instances.</p>
79
78
  *
80
79
  * @throws {@link ServiceDiscoveryServiceException}
81
80
  * <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>
@@ -34,25 +34,23 @@ declare const UpdateServiceCommand_base: {
34
34
  * <li>
35
35
  * <p>Add, update, or delete <code>HealthCheckConfig</code> for a specified service</p>
36
36
  * <note>
37
- * <p>You can't add, update, or delete a <code>HealthCheckCustomConfig</code>
38
- * configuration.</p>
37
+ * <p>You can't add, update, or delete a <code>HealthCheckCustomConfig</code> configuration.</p>
39
38
  * </note>
40
39
  * </li>
41
40
  * </ul>
42
41
  * <p>For public and private DNS namespaces, note the following:</p>
43
42
  * <ul>
44
43
  * <li>
45
- * <p>If you omit any existing <code>DnsRecords</code> or <code>HealthCheckConfig</code>
46
- * configurations from an <code>UpdateService</code> request, the configurations are deleted from
47
- * the service.</p>
44
+ * <p>If you omit any existing <code>DnsRecords</code> or <code>HealthCheckConfig</code> configurations from an
45
+ * <code>UpdateService</code> request, the configurations are deleted from the service.</p>
48
46
  * </li>
49
47
  * <li>
50
48
  * <p>If you omit an existing <code>HealthCheckCustomConfig</code> configuration from an
51
49
  * <code>UpdateService</code> request, the configuration isn't deleted from the service.</p>
52
50
  * </li>
53
51
  * </ul>
54
- * <p>When you update settings for a service, Cloud Map also updates the corresponding settings
55
- * in all the records and health checks that were created by using the specified service.</p>
52
+ * <p>When you update settings for a service, Cloud Map also updates the corresponding settings in all the
53
+ * records and health checks that were created by using the specified service.</p>
56
54
  * @example
57
55
  * Use a bare-bones client and the command you need to make an API call.
58
56
  * ```javascript
@@ -96,9 +94,8 @@ declare const UpdateServiceCommand_base: {
96
94
  * <p>The operation is already in progress.</p>
97
95
  *
98
96
  * @throws {@link InvalidInput} (client fault)
99
- * <p>One or more specified values aren't valid. For example, a required value might be missing, a
100
- * numeric value might be outside the allowed range, or a string value might exceed length
101
- * constraints.</p>
97
+ * <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
98
+ * might be outside the allowed range, or a string value might exceed length constraints.</p>
102
99
  *
103
100
  * @throws {@link ServiceNotFound} (client fault)
104
101
  * <p>No service exists with the specified ID.</p>
@@ -1,11 +1,10 @@
1
1
  /**
2
2
  * <fullname>Cloud Map</fullname>
3
- * <p>With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your
4
- * microservice applications run in. When an instance becomes available, you can call the Cloud Map
5
- * API to register the instance with Cloud Map. For public or private DNS namespaces, Cloud Map
6
- * automatically creates DNS records and an optional health check. Clients that submit public or
7
- * private DNS queries, or HTTP requests, for the service receive an answer that contains up to
8
- * eight healthy records. </p>
3
+ * <p>With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your microservice
4
+ * applications run in. When an instance becomes available, you can call the Cloud Map API to register the
5
+ * instance with Cloud Map. For public or private DNS namespaces, Cloud Map automatically creates DNS records and
6
+ * an optional health check. Clients that submit public or private DNS queries, or HTTP requests, for the service
7
+ * receive an answer that contains up to eight healthy records. </p>
9
8
  *
10
9
  * @packageDocumentation
11
10
  */