@aws-sdk/client-servicediscovery 3.556.0 → 3.561.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.
- package/README.md +5 -6
- package/dist-types/ServiceDiscovery.d.ts +5 -6
- package/dist-types/ServiceDiscoveryClient.d.ts +5 -6
- package/dist-types/commands/CreateHttpNamespaceCommand.d.ts +9 -12
- package/dist-types/commands/CreatePrivateDnsNamespaceCommand.d.ts +11 -14
- package/dist-types/commands/CreatePublicDnsNamespaceCommand.d.ts +13 -14
- package/dist-types/commands/CreateServiceCommand.d.ts +10 -12
- package/dist-types/commands/DeleteNamespaceCommand.d.ts +6 -7
- package/dist-types/commands/DeleteServiceCommand.d.ts +6 -7
- package/dist-types/commands/DeregisterInstanceCommand.d.ts +8 -9
- package/dist-types/commands/DiscoverInstancesCommand.d.ts +8 -10
- package/dist-types/commands/DiscoverInstancesRevisionCommand.d.ts +22 -6
- package/dist-types/commands/GetInstanceCommand.d.ts +4 -5
- package/dist-types/commands/GetInstancesHealthStatusCommand.d.ts +8 -10
- package/dist-types/commands/GetNamespaceCommand.d.ts +2 -3
- package/dist-types/commands/GetOperationCommand.d.ts +2 -3
- package/dist-types/commands/GetServiceCommand.d.ts +2 -3
- package/dist-types/commands/ListInstancesCommand.d.ts +3 -5
- package/dist-types/commands/ListNamespacesCommand.d.ts +2 -3
- package/dist-types/commands/ListOperationsCommand.d.ts +2 -3
- package/dist-types/commands/ListServicesCommand.d.ts +3 -4
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -3
- package/dist-types/commands/RegisterInstanceCommand.d.ts +22 -28
- package/dist-types/commands/TagResourceCommand.d.ts +4 -5
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -3
- package/dist-types/commands/UpdateHttpNamespaceCommand.d.ts +23 -5
- package/dist-types/commands/UpdateInstanceCustomHealthStatusCommand.d.ts +10 -13
- package/dist-types/commands/UpdatePrivateDnsNamespaceCommand.d.ts +44 -5
- package/dist-types/commands/UpdatePublicDnsNamespaceCommand.d.ts +4 -5
- package/dist-types/commands/UpdateServiceCommand.d.ts +7 -10
- package/dist-types/index.d.ts +5 -6
- package/dist-types/models/models_0.d.ts +670 -741
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,12 +8,11 @@ AWS SDK for JavaScript ServiceDiscovery Client for Node.js, Browser and React Na
|
|
|
8
8
|
|
|
9
9
|
<fullname>Cloud Map</fullname>
|
|
10
10
|
|
|
11
|
-
<p>With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
eight healthy records. </p>
|
|
11
|
+
<p>With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your microservice
|
|
12
|
+
applications run in. When an instance becomes available, you can call the Cloud Map API to register the
|
|
13
|
+
instance with Cloud Map. For public or private DNS namespaces, Cloud Map automatically creates DNS records and
|
|
14
|
+
an optional health check. Clients that submit public or private DNS queries, or HTTP requests, for the service
|
|
15
|
+
receive an answer that contains up to eight healthy records. </p>
|
|
17
16
|
|
|
18
17
|
## Installing
|
|
19
18
|
|
|
@@ -196,12 +196,11 @@ export interface ServiceDiscovery {
|
|
|
196
196
|
}
|
|
197
197
|
/**
|
|
198
198
|
* <fullname>Cloud Map</fullname>
|
|
199
|
-
* <p>With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your
|
|
200
|
-
*
|
|
201
|
-
*
|
|
202
|
-
*
|
|
203
|
-
*
|
|
204
|
-
* eight healthy records. </p>
|
|
199
|
+
* <p>With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your microservice
|
|
200
|
+
* applications run in. When an instance becomes available, you can call the Cloud Map API to register the
|
|
201
|
+
* instance with Cloud Map. For public or private DNS namespaces, Cloud Map automatically creates DNS records and
|
|
202
|
+
* an optional health check. Clients that submit public or private DNS queries, or HTTP requests, for the service
|
|
203
|
+
* receive an answer that contains up to eight healthy records. </p>
|
|
205
204
|
* @public
|
|
206
205
|
*/
|
|
207
206
|
export declare class ServiceDiscovery extends ServiceDiscoveryClient implements ServiceDiscovery {
|
|
@@ -179,12 +179,11 @@ export interface ServiceDiscoveryClientResolvedConfig extends ServiceDiscoveryCl
|
|
|
179
179
|
}
|
|
180
180
|
/**
|
|
181
181
|
* <fullname>Cloud Map</fullname>
|
|
182
|
-
* <p>With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your
|
|
183
|
-
*
|
|
184
|
-
*
|
|
185
|
-
*
|
|
186
|
-
*
|
|
187
|
-
* eight healthy records. </p>
|
|
182
|
+
* <p>With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your microservice
|
|
183
|
+
* applications run in. When an instance becomes available, you can call the Cloud Map API to register the
|
|
184
|
+
* instance with Cloud Map. For public or private DNS namespaces, Cloud Map automatically creates DNS records and
|
|
185
|
+
* an optional health check. Clients that submit public or private DNS queries, or HTTP requests, for the service
|
|
186
|
+
* receive an answer that contains up to eight healthy records. </p>
|
|
188
187
|
* @public
|
|
189
188
|
*/
|
|
190
189
|
export declare class ServiceDiscoveryClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ServiceDiscoveryClientResolvedConfig> {
|
|
@@ -26,11 +26,10 @@ declare const CreateHttpNamespaceCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Creates an HTTP namespace. Service instances registered using an HTTP namespace can be
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* <i>Cloud Map Developer Guide</i>.</p>
|
|
29
|
+
* <p>Creates an HTTP namespace. Service instances registered using an HTTP namespace can be discovered using a
|
|
30
|
+
* <code>DiscoverInstances</code> request but can't be discovered using DNS.</p>
|
|
31
|
+
* <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
|
|
32
|
+
* quotas</a> in the <i>Cloud Map Developer Guide</i>.</p>
|
|
34
33
|
* @example
|
|
35
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
35
|
* ```javascript
|
|
@@ -66,20 +65,18 @@ declare const CreateHttpNamespaceCommand_base: {
|
|
|
66
65
|
* <p>The operation is already in progress.</p>
|
|
67
66
|
*
|
|
68
67
|
* @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
|
-
*
|
|
71
|
-
* constraints.</p>
|
|
68
|
+
* <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
|
|
69
|
+
* might be outside the allowed range, or a string value might exceed length constraints.</p>
|
|
72
70
|
*
|
|
73
71
|
* @throws {@link NamespaceAlreadyExists} (client fault)
|
|
74
72
|
* <p>The namespace that you're trying to create already exists.</p>
|
|
75
73
|
*
|
|
76
74
|
* @throws {@link ResourceLimitExceeded} (client fault)
|
|
77
|
-
* <p>The resource can't be created because you've reached the quota on the number of
|
|
78
|
-
* resources.</p>
|
|
75
|
+
* <p>The resource can't be created because you've reached the quota on the number of resources.</p>
|
|
79
76
|
*
|
|
80
77
|
* @throws {@link TooManyTagsException} (client fault)
|
|
81
|
-
* <p>The list of tags on the resource is over the quota. The maximum number of tags that can be
|
|
82
|
-
*
|
|
78
|
+
* <p>The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a
|
|
79
|
+
* resource is 50.</p>
|
|
83
80
|
*
|
|
84
81
|
* @throws {@link ServiceDiscoveryServiceException}
|
|
85
82
|
* <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>
|
|
@@ -26,13 +26,12 @@ declare const CreatePrivateDnsNamespaceCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Creates a private namespace based on DNS, which is visible only inside a specified Amazon
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
* 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
|
|
29
|
+
* <p>Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC. The
|
|
30
|
+
* namespace defines your service naming scheme. For example, if you name your namespace <code>example.com</code>
|
|
31
|
+
* and name your service <code>backend</code>, the resulting DNS name for the service is
|
|
32
|
+
* <code>backend.example.com</code>. Service instances that are registered using a private DNS namespace can be
|
|
33
|
+
* discovered using either a <code>DiscoverInstances</code> request or using DNS. For the current quota on the
|
|
34
|
+
* 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
|
|
36
35
|
* <i>Cloud Map Developer Guide</i>.</p>
|
|
37
36
|
* @example
|
|
38
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -77,20 +76,18 @@ declare const CreatePrivateDnsNamespaceCommand_base: {
|
|
|
77
76
|
* <p>The operation is already in progress.</p>
|
|
78
77
|
*
|
|
79
78
|
* @throws {@link InvalidInput} (client fault)
|
|
80
|
-
* <p>One or more specified values aren't valid. For example, a required value might be missing, a
|
|
81
|
-
*
|
|
82
|
-
* constraints.</p>
|
|
79
|
+
* <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
|
|
80
|
+
* might be outside the allowed range, or a string value might exceed length constraints.</p>
|
|
83
81
|
*
|
|
84
82
|
* @throws {@link NamespaceAlreadyExists} (client fault)
|
|
85
83
|
* <p>The namespace that you're trying to create already exists.</p>
|
|
86
84
|
*
|
|
87
85
|
* @throws {@link ResourceLimitExceeded} (client fault)
|
|
88
|
-
* <p>The resource can't be created because you've reached the quota on the number of
|
|
89
|
-
* resources.</p>
|
|
86
|
+
* <p>The resource can't be created because you've reached the quota on the number of resources.</p>
|
|
90
87
|
*
|
|
91
88
|
* @throws {@link TooManyTagsException} (client fault)
|
|
92
|
-
* <p>The list of tags on the resource is over the quota. The maximum number of tags that can be
|
|
93
|
-
*
|
|
89
|
+
* <p>The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a
|
|
90
|
+
* resource is 50.</p>
|
|
94
91
|
*
|
|
95
92
|
* @throws {@link ServiceDiscoveryServiceException}
|
|
96
93
|
* <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>
|
|
@@ -26,15 +26,16 @@ declare const CreatePublicDnsNamespaceCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Creates a public namespace based on DNS, which is visible on the internet. The namespace
|
|
30
|
-
*
|
|
31
|
-
* <code>
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
29
|
+
* <p>Creates a public namespace based on DNS, which is visible on the internet. The namespace defines your
|
|
30
|
+
* service naming scheme. For example, if you name your namespace <code>example.com</code> and name your service
|
|
31
|
+
* <code>backend</code>, the resulting DNS name for the service is <code>backend.example.com</code>. You can
|
|
32
|
+
* discover instances that were registered with a public DNS namespace by using either a
|
|
33
|
+
* <code>DiscoverInstances</code> request or using DNS. For the current quota on the number of namespaces that you
|
|
34
|
+
* 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
|
|
35
35
|
* <i>Cloud Map Developer Guide</i>.</p>
|
|
36
36
|
* <important>
|
|
37
|
-
* <p>The <code>CreatePublicDnsNamespace</code> API operation is not supported in the Amazon Web Services GovCloud (US)
|
|
37
|
+
* <p>The <code>CreatePublicDnsNamespace</code> API operation is not supported in the Amazon Web Services GovCloud (US)
|
|
38
|
+
* Regions.</p>
|
|
38
39
|
* </important>
|
|
39
40
|
* @example
|
|
40
41
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -78,20 +79,18 @@ declare const CreatePublicDnsNamespaceCommand_base: {
|
|
|
78
79
|
* <p>The operation is already in progress.</p>
|
|
79
80
|
*
|
|
80
81
|
* @throws {@link InvalidInput} (client fault)
|
|
81
|
-
* <p>One or more specified values aren't valid. For example, a required value might be missing, a
|
|
82
|
-
*
|
|
83
|
-
* constraints.</p>
|
|
82
|
+
* <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
|
|
83
|
+
* might be outside the allowed range, or a string value might exceed length constraints.</p>
|
|
84
84
|
*
|
|
85
85
|
* @throws {@link NamespaceAlreadyExists} (client fault)
|
|
86
86
|
* <p>The namespace that you're trying to create already exists.</p>
|
|
87
87
|
*
|
|
88
88
|
* @throws {@link ResourceLimitExceeded} (client fault)
|
|
89
|
-
* <p>The resource can't be created because you've reached the quota on the number of
|
|
90
|
-
* resources.</p>
|
|
89
|
+
* <p>The resource can't be created because you've reached the quota on the number of resources.</p>
|
|
91
90
|
*
|
|
92
91
|
* @throws {@link TooManyTagsException} (client fault)
|
|
93
|
-
* <p>The list of tags on the resource is over the quota. The maximum number of tags that can be
|
|
94
|
-
*
|
|
92
|
+
* <p>The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a
|
|
93
|
+
* resource is 50.</p>
|
|
95
94
|
*
|
|
96
95
|
* @throws {@link ServiceDiscoveryServiceException}
|
|
97
96
|
* <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>
|
|
@@ -63,11 +63,11 @@ declare const CreateServiceCommand_base: {
|
|
|
63
63
|
* <p>Optionally, a health check</p>
|
|
64
64
|
* </li>
|
|
65
65
|
* </ul>
|
|
66
|
-
* <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
|
|
67
|
-
*
|
|
68
|
-
* <p>For the current quota on the number of instances that you can register using the same
|
|
69
|
-
*
|
|
70
|
-
* <i>Cloud Map Developer Guide</i>.</p>
|
|
66
|
+
* <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
|
|
67
|
+
* values in the configuration to create the specified entities.</p>
|
|
68
|
+
* <p>For the current quota on the number of instances that you can register using the same namespace and using
|
|
69
|
+
* the same service, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map
|
|
70
|
+
* quotas</a> in the <i>Cloud Map Developer Guide</i>.</p>
|
|
71
71
|
* @example
|
|
72
72
|
* Use a bare-bones client and the command you need to make an API call.
|
|
73
73
|
* ```javascript
|
|
@@ -148,23 +148,21 @@ declare const CreateServiceCommand_base: {
|
|
|
148
148
|
* @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
|
|
149
149
|
*
|
|
150
150
|
* @throws {@link InvalidInput} (client fault)
|
|
151
|
-
* <p>One or more specified values aren't valid. For example, a required value might be missing, a
|
|
152
|
-
*
|
|
153
|
-
* constraints.</p>
|
|
151
|
+
* <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
|
|
152
|
+
* might be outside the allowed range, or a string value might exceed length constraints.</p>
|
|
154
153
|
*
|
|
155
154
|
* @throws {@link NamespaceNotFound} (client fault)
|
|
156
155
|
* <p>No namespace exists with the specified ID.</p>
|
|
157
156
|
*
|
|
158
157
|
* @throws {@link ResourceLimitExceeded} (client fault)
|
|
159
|
-
* <p>The resource can't be created because you've reached the quota on the number of
|
|
160
|
-
* resources.</p>
|
|
158
|
+
* <p>The resource can't be created because you've reached the quota on the number of resources.</p>
|
|
161
159
|
*
|
|
162
160
|
* @throws {@link ServiceAlreadyExists} (client fault)
|
|
163
161
|
* <p>The service can't be created because a service with the same name already exists.</p>
|
|
164
162
|
*
|
|
165
163
|
* @throws {@link TooManyTagsException} (client fault)
|
|
166
|
-
* <p>The list of tags on the resource is over the quota. The maximum number of tags that can be
|
|
167
|
-
*
|
|
164
|
+
* <p>The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a
|
|
165
|
+
* resource is 50.</p>
|
|
168
166
|
*
|
|
169
167
|
* @throws {@link ServiceDiscoveryServiceException}
|
|
170
168
|
* <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>
|
|
@@ -26,8 +26,8 @@ declare const DeleteNamespaceCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Deletes a namespace from the current account. If the namespace still contains one or more
|
|
30
|
-
*
|
|
29
|
+
* <p>Deletes a namespace from the current account. If the namespace still contains one or more services, the
|
|
30
|
+
* request fails.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -55,16 +55,15 @@ declare const DeleteNamespaceCommand_base: {
|
|
|
55
55
|
* <p>The operation is already in progress.</p>
|
|
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
|
-
*
|
|
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 NamespaceNotFound} (client fault)
|
|
63
62
|
* <p>No namespace exists with the specified ID.</p>
|
|
64
63
|
*
|
|
65
64
|
* @throws {@link ResourceInUse} (client fault)
|
|
66
|
-
* <p>The specified resource can't be deleted because it contains other resources. For example,
|
|
67
|
-
*
|
|
65
|
+
* <p>The specified resource can't be deleted because it contains other resources. For example, you can't delete
|
|
66
|
+
* a service that contains any instances.</p>
|
|
68
67
|
*
|
|
69
68
|
* @throws {@link ServiceDiscoveryServiceException}
|
|
70
69
|
* <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>
|
|
@@ -26,8 +26,8 @@ declare const DeleteServiceCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Deletes a specified service. If the service still contains one or more registered instances,
|
|
30
|
-
*
|
|
29
|
+
* <p>Deletes a specified service. If the service still contains one or more registered instances, the request
|
|
30
|
+
* fails.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -50,13 +50,12 @@ declare const DeleteServiceCommand_base: {
|
|
|
50
50
|
* @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
|
|
51
51
|
*
|
|
52
52
|
* @throws {@link InvalidInput} (client fault)
|
|
53
|
-
* <p>One or more specified values aren't valid. For example, a required value might be missing, a
|
|
54
|
-
*
|
|
55
|
-
* constraints.</p>
|
|
53
|
+
* <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
|
|
54
|
+
* might be outside the allowed range, or a string value might exceed length constraints.</p>
|
|
56
55
|
*
|
|
57
56
|
* @throws {@link ResourceInUse} (client fault)
|
|
58
|
-
* <p>The specified resource can't be deleted because it contains other resources. For example,
|
|
59
|
-
*
|
|
57
|
+
* <p>The specified resource can't be deleted because it contains other resources. For example, you can't delete
|
|
58
|
+
* a service that contains any instances.</p>
|
|
60
59
|
*
|
|
61
60
|
* @throws {@link ServiceNotFound} (client fault)
|
|
62
61
|
* <p>No service exists with the specified ID.</p>
|
|
@@ -26,8 +26,8 @@ declare const DeregisterInstanceCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the
|
|
30
|
-
*
|
|
29
|
+
* <p>Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the specified
|
|
30
|
+
* instance.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -56,17 +56,16 @@ declare const DeregisterInstanceCommand_base: {
|
|
|
56
56
|
* <p>The operation is already in progress.</p>
|
|
57
57
|
*
|
|
58
58
|
* @throws {@link InstanceNotFound} (client fault)
|
|
59
|
-
* <p>No instance exists with the specified ID, or the instance was recently registered, and
|
|
60
|
-
*
|
|
59
|
+
* <p>No instance exists with the specified ID, or the instance was recently registered, and information about
|
|
60
|
+
* the instance hasn't propagated yet.</p>
|
|
61
61
|
*
|
|
62
62
|
* @throws {@link InvalidInput} (client fault)
|
|
63
|
-
* <p>One or more specified values aren't valid. For example, a required value might be missing, a
|
|
64
|
-
*
|
|
65
|
-
* constraints.</p>
|
|
63
|
+
* <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
|
|
64
|
+
* might be outside the allowed range, or a string value might exceed length constraints.</p>
|
|
66
65
|
*
|
|
67
66
|
* @throws {@link ResourceInUse} (client fault)
|
|
68
|
-
* <p>The specified resource can't be deleted because it contains other resources. For example,
|
|
69
|
-
*
|
|
67
|
+
* <p>The specified resource can't be deleted because it contains other resources. For example, you can't delete
|
|
68
|
+
* a service that contains any instances.</p>
|
|
70
69
|
*
|
|
71
70
|
* @throws {@link ServiceNotFound} (client fault)
|
|
72
71
|
* <p>No service exists with the specified ID.</p>
|
|
@@ -27,10 +27,9 @@ declare const DiscoverInstancesCommand_base: {
|
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
29
|
* <p>Discovers registered instances for a specified namespace and service. You can use
|
|
30
|
-
* <code>DiscoverInstances</code> to discover instances for any type of namespace.
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* use DNS queries to discover instances.</p>
|
|
30
|
+
* <code>DiscoverInstances</code> to discover instances for any type of namespace. <code>DiscoverInstances</code>
|
|
31
|
+
* returns a randomized list of instances allowing customers to distribute traffic evenly across instances. For
|
|
32
|
+
* public and private DNS namespaces, you can also use DNS queries to discover instances.</p>
|
|
34
33
|
* @example
|
|
35
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
35
|
* ```javascript
|
|
@@ -75,17 +74,16 @@ declare const DiscoverInstancesCommand_base: {
|
|
|
75
74
|
* @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
|
|
76
75
|
*
|
|
77
76
|
* @throws {@link InvalidInput} (client fault)
|
|
78
|
-
* <p>One or more specified values aren't valid. For example, a required value might be missing, a
|
|
79
|
-
*
|
|
80
|
-
* constraints.</p>
|
|
77
|
+
* <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
|
|
78
|
+
* might be outside the allowed range, or a string value might exceed length constraints.</p>
|
|
81
79
|
*
|
|
82
80
|
* @throws {@link NamespaceNotFound} (client fault)
|
|
83
81
|
* <p>No namespace exists with the specified ID.</p>
|
|
84
82
|
*
|
|
85
83
|
* @throws {@link RequestLimitExceeded} (client fault)
|
|
86
|
-
* <p>The operation can't be completed because you've reached the quota for the number of
|
|
87
|
-
*
|
|
88
|
-
* <i>Cloud Map Developer Guide</i>.</p>
|
|
84
|
+
* <p>The operation can't be completed because you've reached the quota for the number of requests. For more
|
|
85
|
+
* information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/throttling.html">Cloud Map API request
|
|
86
|
+
* throttling quota</a> in the <i>Cloud Map Developer Guide</i>.</p>
|
|
89
87
|
*
|
|
90
88
|
* @throws {@link ServiceNotFound} (client fault)
|
|
91
89
|
* <p>No service exists with the specified ID.</p>
|
|
@@ -52,17 +52,16 @@ declare const DiscoverInstancesRevisionCommand_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
|
-
*
|
|
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 NamespaceNotFound} (client fault)
|
|
60
59
|
* <p>No namespace exists with the specified ID.</p>
|
|
61
60
|
*
|
|
62
61
|
* @throws {@link RequestLimitExceeded} (client fault)
|
|
63
|
-
* <p>The operation can't be completed because you've reached the quota for the number of
|
|
64
|
-
*
|
|
65
|
-
* <i>Cloud Map Developer Guide</i>.</p>
|
|
62
|
+
* <p>The operation can't be completed because you've reached the quota for the number of requests. For more
|
|
63
|
+
* information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/throttling.html">Cloud Map API request
|
|
64
|
+
* throttling quota</a> in the <i>Cloud Map Developer Guide</i>.</p>
|
|
66
65
|
*
|
|
67
66
|
* @throws {@link ServiceNotFound} (client fault)
|
|
68
67
|
* <p>No service exists with the specified ID.</p>
|
|
@@ -71,6 +70,23 @@ declare const DiscoverInstancesRevisionCommand_base: {
|
|
|
71
70
|
* <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>
|
|
72
71
|
*
|
|
73
72
|
* @public
|
|
73
|
+
* @example To discover the revision for a registered instance
|
|
74
|
+
* ```javascript
|
|
75
|
+
* // The following example discovers the revision ID for a registered instance.
|
|
76
|
+
* const input = {
|
|
77
|
+
* "NamespaceName": "example-namespace",
|
|
78
|
+
* "ServiceName": "example-service"
|
|
79
|
+
* };
|
|
80
|
+
* const command = new DiscoverInstancesRevisionCommand(input);
|
|
81
|
+
* const response = await client.send(command);
|
|
82
|
+
* /* response ==
|
|
83
|
+
* {
|
|
84
|
+
* "InstancesRevision": 123456
|
|
85
|
+
* }
|
|
86
|
+
* *\/
|
|
87
|
+
* // example id: to-discover-the-revision-for-a-registered-instance-1712867460953
|
|
88
|
+
* ```
|
|
89
|
+
*
|
|
74
90
|
*/
|
|
75
91
|
export declare class DiscoverInstancesRevisionCommand extends DiscoverInstancesRevisionCommand_base {
|
|
76
92
|
}
|
|
@@ -58,13 +58,12 @@ declare const GetInstanceCommand_base: {
|
|
|
58
58
|
* @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
|
|
59
59
|
*
|
|
60
60
|
* @throws {@link InstanceNotFound} (client fault)
|
|
61
|
-
* <p>No instance exists with the specified ID, or the instance was recently registered, and
|
|
62
|
-
*
|
|
61
|
+
* <p>No instance exists with the specified ID, or the instance was recently registered, and information about
|
|
62
|
+
* the instance hasn't propagated yet.</p>
|
|
63
63
|
*
|
|
64
64
|
* @throws {@link InvalidInput} (client fault)
|
|
65
|
-
* <p>One or more specified values aren't valid. For example, a required value might be missing, a
|
|
66
|
-
*
|
|
67
|
-
* constraints.</p>
|
|
65
|
+
* <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
|
|
66
|
+
* might be outside the allowed range, or a string value might exceed length constraints.</p>
|
|
68
67
|
*
|
|
69
68
|
* @throws {@link ServiceNotFound} (client fault)
|
|
70
69
|
* <p>No service exists with the specified ID.</p>
|
|
@@ -26,12 +26,11 @@ declare const GetInstancesHealthStatusCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Gets the current health status (<code>Healthy</code>, <code>Unhealthy</code>, or
|
|
30
|
-
*
|
|
31
|
-
* service.</p>
|
|
29
|
+
* <p>Gets the current health status (<code>Healthy</code>, <code>Unhealthy</code>, or <code>Unknown</code>) of
|
|
30
|
+
* one or more instances that are associated with a specified service.</p>
|
|
32
31
|
* <note>
|
|
33
|
-
* <p>There's a brief delay between when you register an instance and when the health status for
|
|
34
|
-
*
|
|
32
|
+
* <p>There's a brief delay between when you register an instance and when the health status for the instance is
|
|
33
|
+
* available. </p>
|
|
35
34
|
* </note>
|
|
36
35
|
* @example
|
|
37
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -65,13 +64,12 @@ declare const GetInstancesHealthStatusCommand_base: {
|
|
|
65
64
|
* @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
|
|
66
65
|
*
|
|
67
66
|
* @throws {@link InstanceNotFound} (client fault)
|
|
68
|
-
* <p>No instance exists with the specified ID, or the instance was recently registered, and
|
|
69
|
-
*
|
|
67
|
+
* <p>No instance exists with the specified ID, or the instance was recently registered, and information about
|
|
68
|
+
* the instance hasn't propagated yet.</p>
|
|
70
69
|
*
|
|
71
70
|
* @throws {@link InvalidInput} (client fault)
|
|
72
|
-
* <p>One or more specified values aren't valid. For example, a required value might be missing, a
|
|
73
|
-
*
|
|
74
|
-
* constraints.</p>
|
|
71
|
+
* <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
|
|
72
|
+
* might be outside the allowed range, or a string value might exceed length constraints.</p>
|
|
75
73
|
*
|
|
76
74
|
* @throws {@link ServiceNotFound} (client fault)
|
|
77
75
|
* <p>No service exists with the specified ID.</p>
|
|
@@ -71,9 +71,8 @@ declare const GetNamespaceCommand_base: {
|
|
|
71
71
|
* @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
|
|
72
72
|
*
|
|
73
73
|
* @throws {@link InvalidInput} (client fault)
|
|
74
|
-
* <p>One or more specified values aren't valid. For example, a required value might be missing, a
|
|
75
|
-
*
|
|
76
|
-
* constraints.</p>
|
|
74
|
+
* <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
|
|
75
|
+
* might be outside the allowed range, or a string value might exceed length constraints.</p>
|
|
77
76
|
*
|
|
78
77
|
* @throws {@link NamespaceNotFound} (client fault)
|
|
79
78
|
* <p>No namespace exists with the specified ID.</p>
|
|
@@ -66,9 +66,8 @@ declare const GetOperationCommand_base: {
|
|
|
66
66
|
* @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
|
|
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
|
-
*
|
|
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 OperationNotFound} (client fault)
|
|
74
73
|
* <p>No operation exists with the specified ID.</p>
|
|
@@ -79,9 +79,8 @@ declare const GetServiceCommand_base: {
|
|
|
79
79
|
* @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
|
|
80
80
|
*
|
|
81
81
|
* @throws {@link InvalidInput} (client fault)
|
|
82
|
-
* <p>One or more specified values aren't valid. For example, a required value might be missing, a
|
|
83
|
-
*
|
|
84
|
-
* constraints.</p>
|
|
82
|
+
* <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
|
|
83
|
+
* might be outside the allowed range, or a string value might exceed length constraints.</p>
|
|
85
84
|
*
|
|
86
85
|
* @throws {@link ServiceNotFound} (client fault)
|
|
87
86
|
* <p>No service exists with the specified ID.</p>
|
|
@@ -26,8 +26,7 @@ declare const ListInstancesCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Lists summary information about the instances that you registered by using a specified
|
|
30
|
-
* service.</p>
|
|
29
|
+
* <p>Lists summary information about the instances that you registered by using a specified service.</p>
|
|
31
30
|
* @example
|
|
32
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
32
|
* ```javascript
|
|
@@ -62,9 +61,8 @@ declare const ListInstancesCommand_base: {
|
|
|
62
61
|
* @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
|
|
63
62
|
*
|
|
64
63
|
* @throws {@link InvalidInput} (client fault)
|
|
65
|
-
* <p>One or more specified values aren't valid. For example, a required value might be missing, a
|
|
66
|
-
*
|
|
67
|
-
* constraints.</p>
|
|
64
|
+
* <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
|
|
65
|
+
* might be outside the allowed range, or a string value might exceed length constraints.</p>
|
|
68
66
|
*
|
|
69
67
|
* @throws {@link ServiceNotFound} (client fault)
|
|
70
68
|
* <p>No service exists with the specified ID.</p>
|
|
@@ -83,9 +83,8 @@ declare const ListNamespacesCommand_base: {
|
|
|
83
83
|
* @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
|
|
84
84
|
*
|
|
85
85
|
* @throws {@link InvalidInput} (client fault)
|
|
86
|
-
* <p>One or more specified values aren't valid. For example, a required value might be missing, a
|
|
87
|
-
*
|
|
88
|
-
* constraints.</p>
|
|
86
|
+
* <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
|
|
87
|
+
* might be outside the allowed range, or a string value might exceed length constraints.</p>
|
|
89
88
|
*
|
|
90
89
|
* @throws {@link ServiceDiscoveryServiceException}
|
|
91
90
|
* <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>
|
|
@@ -67,9 +67,8 @@ declare const ListOperationsCommand_base: {
|
|
|
67
67
|
* @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
|
|
68
68
|
*
|
|
69
69
|
* @throws {@link InvalidInput} (client fault)
|
|
70
|
-
* <p>One or more specified values aren't valid. For example, a required value might be missing, a
|
|
71
|
-
*
|
|
72
|
-
* constraints.</p>
|
|
70
|
+
* <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
|
|
71
|
+
* might be outside the allowed range, or a string value might exceed length constraints.</p>
|
|
73
72
|
*
|
|
74
73
|
* @throws {@link ServiceDiscoveryServiceException}
|
|
75
74
|
* <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>
|
|
@@ -27,7 +27,7 @@ declare const ListServicesCommand_base: {
|
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
29
|
* <p>Lists summary information for all the services that are associated with one or more
|
|
30
|
-
*
|
|
30
|
+
* namespaces.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -91,9 +91,8 @@ declare const ListServicesCommand_base: {
|
|
|
91
91
|
* @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
|
|
92
92
|
*
|
|
93
93
|
* @throws {@link InvalidInput} (client fault)
|
|
94
|
-
* <p>One or more specified values aren't valid. For example, a required value might be missing, a
|
|
95
|
-
*
|
|
96
|
-
* constraints.</p>
|
|
94
|
+
* <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
|
|
95
|
+
* might be outside the allowed range, or a string value might exceed length constraints.</p>
|
|
97
96
|
*
|
|
98
97
|
* @throws {@link ServiceDiscoveryServiceException}
|
|
99
98
|
* <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>
|
|
@@ -56,9 +56,8 @@ declare const ListTagsForResourceCommand_base: {
|
|
|
56
56
|
* @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
|
|
57
57
|
*
|
|
58
58
|
* @throws {@link InvalidInput} (client fault)
|
|
59
|
-
* <p>One or more specified values aren't valid. For example, a required value might be missing, a
|
|
60
|
-
*
|
|
61
|
-
* constraints.</p>
|
|
59
|
+
* <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
|
|
60
|
+
* might be outside the allowed range, or a string value might exceed length constraints.</p>
|
|
62
61
|
*
|
|
63
62
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
64
63
|
* <p>The operation can't be completed because the resource was not found.</p>
|