@aws-sdk/client-servicediscovery 3.295.0 → 3.297.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 (37) hide show
  1. package/dist-types/ServiceDiscovery.d.ts +27 -0
  2. package/dist-types/ServiceDiscoveryClient.d.ts +24 -4
  3. package/dist-types/commands/CreateHttpNamespaceCommand.d.ts +16 -0
  4. package/dist-types/commands/CreatePrivateDnsNamespaceCommand.d.ts +16 -0
  5. package/dist-types/commands/CreatePublicDnsNamespaceCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateServiceCommand.d.ts +16 -0
  7. package/dist-types/commands/DeleteNamespaceCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteServiceCommand.d.ts +16 -0
  9. package/dist-types/commands/DeregisterInstanceCommand.d.ts +16 -0
  10. package/dist-types/commands/DiscoverInstancesCommand.d.ts +16 -0
  11. package/dist-types/commands/GetInstanceCommand.d.ts +16 -0
  12. package/dist-types/commands/GetInstancesHealthStatusCommand.d.ts +16 -0
  13. package/dist-types/commands/GetNamespaceCommand.d.ts +16 -0
  14. package/dist-types/commands/GetOperationCommand.d.ts +16 -0
  15. package/dist-types/commands/GetServiceCommand.d.ts +16 -0
  16. package/dist-types/commands/ListInstancesCommand.d.ts +16 -0
  17. package/dist-types/commands/ListNamespacesCommand.d.ts +16 -0
  18. package/dist-types/commands/ListOperationsCommand.d.ts +16 -0
  19. package/dist-types/commands/ListServicesCommand.d.ts +16 -0
  20. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  21. package/dist-types/commands/RegisterInstanceCommand.d.ts +16 -0
  22. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  23. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  24. package/dist-types/commands/UpdateHttpNamespaceCommand.d.ts +16 -0
  25. package/dist-types/commands/UpdateInstanceCustomHealthStatusCommand.d.ts +16 -0
  26. package/dist-types/commands/UpdatePrivateDnsNamespaceCommand.d.ts +16 -0
  27. package/dist-types/commands/UpdatePublicDnsNamespaceCommand.d.ts +16 -0
  28. package/dist-types/commands/UpdateServiceCommand.d.ts +16 -0
  29. package/dist-types/models/ServiceDiscoveryServiceException.d.ts +2 -0
  30. package/dist-types/models/models_0.d.ts +251 -1
  31. package/dist-types/pagination/GetInstancesHealthStatusPaginator.d.ts +3 -0
  32. package/dist-types/pagination/Interfaces.d.ts +3 -0
  33. package/dist-types/pagination/ListInstancesPaginator.d.ts +3 -0
  34. package/dist-types/pagination/ListNamespacesPaginator.d.ts +3 -0
  35. package/dist-types/pagination/ListOperationsPaginator.d.ts +3 -0
  36. package/dist-types/pagination/ListServicesPaginator.d.ts +3 -0
  37. package/package.json +29 -29
@@ -27,6 +27,7 @@ import { UpdatePublicDnsNamespaceCommandInput, UpdatePublicDnsNamespaceCommandOu
27
27
  import { UpdateServiceCommandInput, UpdateServiceCommandOutput } from "./commands/UpdateServiceCommand";
28
28
  import { ServiceDiscoveryClient } from "./ServiceDiscoveryClient";
29
29
  /**
30
+ * @public
30
31
  * <fullname>Cloud Map</fullname>
31
32
  * <p>With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your
32
33
  * microservice applications run in. When an instance becomes available, you can call the Cloud Map
@@ -37,6 +38,7 @@ import { ServiceDiscoveryClient } from "./ServiceDiscoveryClient";
37
38
  */
38
39
  export declare class ServiceDiscovery extends ServiceDiscoveryClient {
39
40
  /**
41
+ * @public
40
42
  * <p>Creates an HTTP namespace. Service instances registered using an HTTP namespace can be
41
43
  * discovered using a <code>DiscoverInstances</code> request but can't be discovered using
42
44
  * DNS.</p>
@@ -47,6 +49,7 @@ export declare class ServiceDiscovery extends ServiceDiscoveryClient {
47
49
  createHttpNamespace(args: CreateHttpNamespaceCommandInput, cb: (err: any, data?: CreateHttpNamespaceCommandOutput) => void): void;
48
50
  createHttpNamespace(args: CreateHttpNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHttpNamespaceCommandOutput) => void): void;
49
51
  /**
52
+ * @public
50
53
  * <p>Creates a private namespace based on DNS, which is visible only inside a specified Amazon
51
54
  * VPC. The namespace defines your service naming scheme. For example, if you name your namespace
52
55
  * <code>example.com</code> and name your service <code>backend</code>, the resulting DNS name for
@@ -60,6 +63,7 @@ export declare class ServiceDiscovery extends ServiceDiscoveryClient {
60
63
  createPrivateDnsNamespace(args: CreatePrivateDnsNamespaceCommandInput, cb: (err: any, data?: CreatePrivateDnsNamespaceCommandOutput) => void): void;
61
64
  createPrivateDnsNamespace(args: CreatePrivateDnsNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePrivateDnsNamespaceCommandOutput) => void): void;
62
65
  /**
66
+ * @public
63
67
  * <p>Creates a public namespace based on DNS, which is visible on the internet. The namespace
64
68
  * defines your service naming scheme. For example, if you name your namespace
65
69
  * <code>example.com</code> and name your service <code>backend</code>, the resulting DNS name for
@@ -75,6 +79,7 @@ export declare class ServiceDiscovery extends ServiceDiscoveryClient {
75
79
  createPublicDnsNamespace(args: CreatePublicDnsNamespaceCommandInput, cb: (err: any, data?: CreatePublicDnsNamespaceCommandOutput) => void): void;
76
80
  createPublicDnsNamespace(args: CreatePublicDnsNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePublicDnsNamespaceCommandOutput) => void): void;
77
81
  /**
82
+ * @public
78
83
  * <p>Creates a service. This action defines the configuration for the following entities:</p>
79
84
  * <ul>
80
85
  * <li>
@@ -122,6 +127,7 @@ export declare class ServiceDiscovery extends ServiceDiscoveryClient {
122
127
  createService(args: CreateServiceCommandInput, cb: (err: any, data?: CreateServiceCommandOutput) => void): void;
123
128
  createService(args: CreateServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceCommandOutput) => void): void;
124
129
  /**
130
+ * @public
125
131
  * <p>Deletes a namespace from the current account. If the namespace still contains one or more
126
132
  * services, the request fails.</p>
127
133
  */
@@ -129,6 +135,7 @@ export declare class ServiceDiscovery extends ServiceDiscoveryClient {
129
135
  deleteNamespace(args: DeleteNamespaceCommandInput, cb: (err: any, data?: DeleteNamespaceCommandOutput) => void): void;
130
136
  deleteNamespace(args: DeleteNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNamespaceCommandOutput) => void): void;
131
137
  /**
138
+ * @public
132
139
  * <p>Deletes a specified service. If the service still contains one or more registered instances,
133
140
  * the request fails.</p>
134
141
  */
@@ -136,6 +143,7 @@ export declare class ServiceDiscovery extends ServiceDiscoveryClient {
136
143
  deleteService(args: DeleteServiceCommandInput, cb: (err: any, data?: DeleteServiceCommandOutput) => void): void;
137
144
  deleteService(args: DeleteServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServiceCommandOutput) => void): void;
138
145
  /**
146
+ * @public
139
147
  * <p>Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the
140
148
  * specified instance.</p>
141
149
  */
@@ -143,6 +151,7 @@ export declare class ServiceDiscovery extends ServiceDiscoveryClient {
143
151
  deregisterInstance(args: DeregisterInstanceCommandInput, cb: (err: any, data?: DeregisterInstanceCommandOutput) => void): void;
144
152
  deregisterInstance(args: DeregisterInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterInstanceCommandOutput) => void): void;
145
153
  /**
154
+ * @public
146
155
  * <p>Discovers registered instances for a specified namespace and service. You can use
147
156
  * <code>DiscoverInstances</code> to discover instances for any type of namespace. For public and
148
157
  * private DNS namespaces, you can also use DNS queries to discover instances.</p>
@@ -151,12 +160,14 @@ export declare class ServiceDiscovery extends ServiceDiscoveryClient {
151
160
  discoverInstances(args: DiscoverInstancesCommandInput, cb: (err: any, data?: DiscoverInstancesCommandOutput) => void): void;
152
161
  discoverInstances(args: DiscoverInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DiscoverInstancesCommandOutput) => void): void;
153
162
  /**
163
+ * @public
154
164
  * <p>Gets information about a specified instance.</p>
155
165
  */
156
166
  getInstance(args: GetInstanceCommandInput, options?: __HttpHandlerOptions): Promise<GetInstanceCommandOutput>;
157
167
  getInstance(args: GetInstanceCommandInput, cb: (err: any, data?: GetInstanceCommandOutput) => void): void;
158
168
  getInstance(args: GetInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInstanceCommandOutput) => void): void;
159
169
  /**
170
+ * @public
160
171
  * <p>Gets the current health status (<code>Healthy</code>, <code>Unhealthy</code>, or
161
172
  * <code>Unknown</code>) of one or more instances that are associated with a specified
162
173
  * service.</p>
@@ -169,12 +180,14 @@ export declare class ServiceDiscovery extends ServiceDiscoveryClient {
169
180
  getInstancesHealthStatus(args: GetInstancesHealthStatusCommandInput, cb: (err: any, data?: GetInstancesHealthStatusCommandOutput) => void): void;
170
181
  getInstancesHealthStatus(args: GetInstancesHealthStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInstancesHealthStatusCommandOutput) => void): void;
171
182
  /**
183
+ * @public
172
184
  * <p>Gets information about a namespace.</p>
173
185
  */
174
186
  getNamespace(args: GetNamespaceCommandInput, options?: __HttpHandlerOptions): Promise<GetNamespaceCommandOutput>;
175
187
  getNamespace(args: GetNamespaceCommandInput, cb: (err: any, data?: GetNamespaceCommandOutput) => void): void;
176
188
  getNamespace(args: GetNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNamespaceCommandOutput) => void): void;
177
189
  /**
190
+ * @public
178
191
  * <p>Gets information about any operation that returns an operation ID in the response, such as a
179
192
  * <code>CreateService</code> request.</p>
180
193
  * <note>
@@ -185,12 +198,14 @@ export declare class ServiceDiscovery extends ServiceDiscoveryClient {
185
198
  getOperation(args: GetOperationCommandInput, cb: (err: any, data?: GetOperationCommandOutput) => void): void;
186
199
  getOperation(args: GetOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOperationCommandOutput) => void): void;
187
200
  /**
201
+ * @public
188
202
  * <p>Gets the settings for a specified service.</p>
189
203
  */
190
204
  getService(args: GetServiceCommandInput, options?: __HttpHandlerOptions): Promise<GetServiceCommandOutput>;
191
205
  getService(args: GetServiceCommandInput, cb: (err: any, data?: GetServiceCommandOutput) => void): void;
192
206
  getService(args: GetServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceCommandOutput) => void): void;
193
207
  /**
208
+ * @public
194
209
  * <p>Lists summary information about the instances that you registered by using a specified
195
210
  * service.</p>
196
211
  */
@@ -198,18 +213,21 @@ export declare class ServiceDiscovery extends ServiceDiscoveryClient {
198
213
  listInstances(args: ListInstancesCommandInput, cb: (err: any, data?: ListInstancesCommandOutput) => void): void;
199
214
  listInstances(args: ListInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInstancesCommandOutput) => void): void;
200
215
  /**
216
+ * @public
201
217
  * <p>Lists summary information about the namespaces that were created by the current Amazon Web Services account.</p>
202
218
  */
203
219
  listNamespaces(args: ListNamespacesCommandInput, options?: __HttpHandlerOptions): Promise<ListNamespacesCommandOutput>;
204
220
  listNamespaces(args: ListNamespacesCommandInput, cb: (err: any, data?: ListNamespacesCommandOutput) => void): void;
205
221
  listNamespaces(args: ListNamespacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNamespacesCommandOutput) => void): void;
206
222
  /**
223
+ * @public
207
224
  * <p>Lists operations that match the criteria that you specify.</p>
208
225
  */
209
226
  listOperations(args: ListOperationsCommandInput, options?: __HttpHandlerOptions): Promise<ListOperationsCommandOutput>;
210
227
  listOperations(args: ListOperationsCommandInput, cb: (err: any, data?: ListOperationsCommandOutput) => void): void;
211
228
  listOperations(args: ListOperationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOperationsCommandOutput) => void): void;
212
229
  /**
230
+ * @public
213
231
  * <p>Lists summary information for all the services that are associated with one or more
214
232
  * specified namespaces.</p>
215
233
  */
@@ -217,12 +235,14 @@ export declare class ServiceDiscovery extends ServiceDiscoveryClient {
217
235
  listServices(args: ListServicesCommandInput, cb: (err: any, data?: ListServicesCommandOutput) => void): void;
218
236
  listServices(args: ListServicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServicesCommandOutput) => void): void;
219
237
  /**
238
+ * @public
220
239
  * <p>Lists tags for the specified resource.</p>
221
240
  */
222
241
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
223
242
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
224
243
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
225
244
  /**
245
+ * @public
226
246
  * <p>Creates or updates one or more records and, optionally, creates a health check based on the
227
247
  * settings in a specified service. When you submit a <code>RegisterInstance</code> request, the
228
248
  * following occurs:</p>
@@ -272,18 +292,21 @@ export declare class ServiceDiscovery extends ServiceDiscoveryClient {
272
292
  registerInstance(args: RegisterInstanceCommandInput, cb: (err: any, data?: RegisterInstanceCommandOutput) => void): void;
273
293
  registerInstance(args: RegisterInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterInstanceCommandOutput) => void): void;
274
294
  /**
295
+ * @public
275
296
  * <p>Adds one or more tags to the specified resource.</p>
276
297
  */
277
298
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
278
299
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
279
300
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
280
301
  /**
302
+ * @public
281
303
  * <p>Removes one or more tags from the specified resource.</p>
282
304
  */
283
305
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
284
306
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
285
307
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
286
308
  /**
309
+ * @public
287
310
  * <p>Updates an HTTP
288
311
  * namespace.</p>
289
312
  */
@@ -291,6 +314,7 @@ export declare class ServiceDiscovery extends ServiceDiscoveryClient {
291
314
  updateHttpNamespace(args: UpdateHttpNamespaceCommandInput, cb: (err: any, data?: UpdateHttpNamespaceCommandOutput) => void): void;
292
315
  updateHttpNamespace(args: UpdateHttpNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateHttpNamespaceCommandOutput) => void): void;
293
316
  /**
317
+ * @public
294
318
  * <p>Submits a request to change the health status of a custom health check to healthy or
295
319
  * unhealthy.</p>
296
320
  * <p>You can use <code>UpdateInstanceCustomHealthStatus</code> to change the status only for
@@ -303,6 +327,7 @@ export declare class ServiceDiscovery extends ServiceDiscoveryClient {
303
327
  updateInstanceCustomHealthStatus(args: UpdateInstanceCustomHealthStatusCommandInput, cb: (err: any, data?: UpdateInstanceCustomHealthStatusCommandOutput) => void): void;
304
328
  updateInstanceCustomHealthStatus(args: UpdateInstanceCustomHealthStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateInstanceCustomHealthStatusCommandOutput) => void): void;
305
329
  /**
330
+ * @public
306
331
  * <p>Updates a private DNS
307
332
  * namespace.</p>
308
333
  */
@@ -310,6 +335,7 @@ export declare class ServiceDiscovery extends ServiceDiscoveryClient {
310
335
  updatePrivateDnsNamespace(args: UpdatePrivateDnsNamespaceCommandInput, cb: (err: any, data?: UpdatePrivateDnsNamespaceCommandOutput) => void): void;
311
336
  updatePrivateDnsNamespace(args: UpdatePrivateDnsNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePrivateDnsNamespaceCommandOutput) => void): void;
312
337
  /**
338
+ * @public
313
339
  * <p>Updates a public DNS
314
340
  * namespace.</p>
315
341
  */
@@ -317,6 +343,7 @@ export declare class ServiceDiscovery extends ServiceDiscoveryClient {
317
343
  updatePublicDnsNamespace(args: UpdatePublicDnsNamespaceCommandInput, cb: (err: any, data?: UpdatePublicDnsNamespaceCommandOutput) => void): void;
318
344
  updatePublicDnsNamespace(args: UpdatePublicDnsNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePublicDnsNamespaceCommandOutput) => void): void;
319
345
  /**
346
+ * @public
320
347
  * <p>Submits a request to perform the following operations:</p>
321
348
  * <ul>
322
349
  * <li>
@@ -34,15 +34,24 @@ import { UpdatePrivateDnsNamespaceCommandInput, UpdatePrivateDnsNamespaceCommand
34
34
  import { UpdatePublicDnsNamespaceCommandInput, UpdatePublicDnsNamespaceCommandOutput } from "./commands/UpdatePublicDnsNamespaceCommand";
35
35
  import { UpdateServiceCommandInput, UpdateServiceCommandOutput } from "./commands/UpdateServiceCommand";
36
36
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
37
+ /**
38
+ * @public
39
+ */
37
40
  export type ServiceInputTypes = CreateHttpNamespaceCommandInput | CreatePrivateDnsNamespaceCommandInput | CreatePublicDnsNamespaceCommandInput | CreateServiceCommandInput | DeleteNamespaceCommandInput | DeleteServiceCommandInput | DeregisterInstanceCommandInput | DiscoverInstancesCommandInput | GetInstanceCommandInput | GetInstancesHealthStatusCommandInput | GetNamespaceCommandInput | GetOperationCommandInput | GetServiceCommandInput | ListInstancesCommandInput | ListNamespacesCommandInput | ListOperationsCommandInput | ListServicesCommandInput | ListTagsForResourceCommandInput | RegisterInstanceCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateHttpNamespaceCommandInput | UpdateInstanceCustomHealthStatusCommandInput | UpdatePrivateDnsNamespaceCommandInput | UpdatePublicDnsNamespaceCommandInput | UpdateServiceCommandInput;
41
+ /**
42
+ * @public
43
+ */
38
44
  export type ServiceOutputTypes = CreateHttpNamespaceCommandOutput | CreatePrivateDnsNamespaceCommandOutput | CreatePublicDnsNamespaceCommandOutput | CreateServiceCommandOutput | DeleteNamespaceCommandOutput | DeleteServiceCommandOutput | DeregisterInstanceCommandOutput | DiscoverInstancesCommandOutput | GetInstanceCommandOutput | GetInstancesHealthStatusCommandOutput | GetNamespaceCommandOutput | GetOperationCommandOutput | GetServiceCommandOutput | ListInstancesCommandOutput | ListNamespacesCommandOutput | ListOperationsCommandOutput | ListServicesCommandOutput | ListTagsForResourceCommandOutput | RegisterInstanceCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateHttpNamespaceCommandOutput | UpdateInstanceCustomHealthStatusCommandOutput | UpdatePrivateDnsNamespaceCommandOutput | UpdatePublicDnsNamespaceCommandOutput | UpdateServiceCommandOutput;
45
+ /**
46
+ * @public
47
+ */
39
48
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
40
49
  /**
41
50
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
42
51
  */
43
52
  requestHandler?: __HttpHandler;
44
53
  /**
45
- * A constructor for a class implementing the {@link __Checksum} interface
54
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
46
55
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
47
56
  * @internal
48
57
  */
@@ -132,23 +141,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
132
141
  */
133
142
  logger?: __Logger;
134
143
  /**
135
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
144
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
136
145
  */
137
146
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
138
147
  }
148
+ /**
149
+ * @public
150
+ */
139
151
  type ServiceDiscoveryClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
140
152
  /**
141
- * The configuration interface of ServiceDiscoveryClient class constructor that set the region, credentials and other options.
153
+ * @public
154
+ *
155
+ * The configuration interface of ServiceDiscoveryClient class constructor that set the region, credentials and other options.
142
156
  */
143
157
  export interface ServiceDiscoveryClientConfig extends ServiceDiscoveryClientConfigType {
144
158
  }
159
+ /**
160
+ * @public
161
+ */
145
162
  type ServiceDiscoveryClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
146
163
  /**
147
- * The resolved configuration interface of ServiceDiscoveryClient class. This is resolved and normalized from the {@link ServiceDiscoveryClientConfig | constructor configuration interface}.
164
+ * @public
165
+ *
166
+ * The resolved configuration interface of ServiceDiscoveryClient class. This is resolved and normalized from the {@link ServiceDiscoveryClientConfig | constructor configuration interface}.
148
167
  */
149
168
  export interface ServiceDiscoveryClientResolvedConfig extends ServiceDiscoveryClientResolvedConfigType {
150
169
  }
151
170
  /**
171
+ * @public
152
172
  * <fullname>Cloud Map</fullname>
153
173
  * <p>With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your
154
174
  * microservice applications run in. When an instance becomes available, you can call the Cloud Map
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateHttpNamespaceRequest, CreateHttpNamespaceResponse } from "../models/models_0";
5
5
  import { ServiceDiscoveryClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ServiceDiscoveryClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateHttpNamespaceCommand}.
8
10
  */
9
11
  export interface CreateHttpNamespaceCommandInput extends CreateHttpNamespaceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateHttpNamespaceCommand}.
13
17
  */
14
18
  export interface CreateHttpNamespaceCommandOutput extends CreateHttpNamespaceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates an HTTP namespace. Service instances registered using an HTTP namespace can be
18
23
  * discovered using a <code>DiscoverInstances</code> request but can't be discovered using
19
24
  * DNS.</p>
@@ -29,6 +34,8 @@ export interface CreateHttpNamespaceCommandOutput extends CreateHttpNamespaceRes
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param CreateHttpNamespaceCommandInput - {@link CreateHttpNamespaceCommandInput}
38
+ * @returns {@link CreateHttpNamespaceCommandOutput}
32
39
  * @see {@link CreateHttpNamespaceCommandInput} for command's `input` shape.
33
40
  * @see {@link CreateHttpNamespaceCommandOutput} for command's `response` shape.
34
41
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
@@ -80,11 +87,20 @@ export interface CreateHttpNamespaceCommandOutput extends CreateHttpNamespaceRes
80
87
  export declare class CreateHttpNamespaceCommand extends $Command<CreateHttpNamespaceCommandInput, CreateHttpNamespaceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
81
88
  readonly input: CreateHttpNamespaceCommandInput;
82
89
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
90
+ /**
91
+ * @public
92
+ */
83
93
  constructor(input: CreateHttpNamespaceCommandInput);
84
94
  /**
85
95
  * @internal
86
96
  */
87
97
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ServiceDiscoveryClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateHttpNamespaceCommandInput, CreateHttpNamespaceCommandOutput>;
98
+ /**
99
+ * @internal
100
+ */
88
101
  private serialize;
102
+ /**
103
+ * @internal
104
+ */
89
105
  private deserialize;
90
106
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreatePrivateDnsNamespaceRequest, CreatePrivateDnsNamespaceResponse } from "../models/models_0";
5
5
  import { ServiceDiscoveryClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ServiceDiscoveryClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreatePrivateDnsNamespaceCommand}.
8
10
  */
9
11
  export interface CreatePrivateDnsNamespaceCommandInput extends CreatePrivateDnsNamespaceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreatePrivateDnsNamespaceCommand}.
13
17
  */
14
18
  export interface CreatePrivateDnsNamespaceCommandOutput extends CreatePrivateDnsNamespaceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a private namespace based on DNS, which is visible only inside a specified Amazon
18
23
  * VPC. The namespace defines your service naming scheme. For example, if you name your namespace
19
24
  * <code>example.com</code> and name your service <code>backend</code>, the resulting DNS name for
@@ -32,6 +37,8 @@ export interface CreatePrivateDnsNamespaceCommandOutput extends CreatePrivateDns
32
37
  * const response = await client.send(command);
33
38
  * ```
34
39
  *
40
+ * @param CreatePrivateDnsNamespaceCommandInput - {@link CreatePrivateDnsNamespaceCommandInput}
41
+ * @returns {@link CreatePrivateDnsNamespaceCommandOutput}
35
42
  * @see {@link CreatePrivateDnsNamespaceCommandInput} for command's `input` shape.
36
43
  * @see {@link CreatePrivateDnsNamespaceCommandOutput} for command's `response` shape.
37
44
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
@@ -83,11 +90,20 @@ export interface CreatePrivateDnsNamespaceCommandOutput extends CreatePrivateDns
83
90
  export declare class CreatePrivateDnsNamespaceCommand extends $Command<CreatePrivateDnsNamespaceCommandInput, CreatePrivateDnsNamespaceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
84
91
  readonly input: CreatePrivateDnsNamespaceCommandInput;
85
92
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
93
+ /**
94
+ * @public
95
+ */
86
96
  constructor(input: CreatePrivateDnsNamespaceCommandInput);
87
97
  /**
88
98
  * @internal
89
99
  */
90
100
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ServiceDiscoveryClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreatePrivateDnsNamespaceCommandInput, CreatePrivateDnsNamespaceCommandOutput>;
101
+ /**
102
+ * @internal
103
+ */
91
104
  private serialize;
105
+ /**
106
+ * @internal
107
+ */
92
108
  private deserialize;
93
109
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreatePublicDnsNamespaceRequest, CreatePublicDnsNamespaceResponse } from "../models/models_0";
5
5
  import { ServiceDiscoveryClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ServiceDiscoveryClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreatePublicDnsNamespaceCommand}.
8
10
  */
9
11
  export interface CreatePublicDnsNamespaceCommandInput extends CreatePublicDnsNamespaceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreatePublicDnsNamespaceCommand}.
13
17
  */
14
18
  export interface CreatePublicDnsNamespaceCommandOutput extends CreatePublicDnsNamespaceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a public namespace based on DNS, which is visible on the internet. The namespace
18
23
  * defines your service naming scheme. For example, if you name your namespace
19
24
  * <code>example.com</code> and name your service <code>backend</code>, the resulting DNS name for
@@ -34,6 +39,8 @@ export interface CreatePublicDnsNamespaceCommandOutput extends CreatePublicDnsNa
34
39
  * const response = await client.send(command);
35
40
  * ```
36
41
  *
42
+ * @param CreatePublicDnsNamespaceCommandInput - {@link CreatePublicDnsNamespaceCommandInput}
43
+ * @returns {@link CreatePublicDnsNamespaceCommandOutput}
37
44
  * @see {@link CreatePublicDnsNamespaceCommandInput} for command's `input` shape.
38
45
  * @see {@link CreatePublicDnsNamespaceCommandOutput} for command's `response` shape.
39
46
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
@@ -85,11 +92,20 @@ export interface CreatePublicDnsNamespaceCommandOutput extends CreatePublicDnsNa
85
92
  export declare class CreatePublicDnsNamespaceCommand extends $Command<CreatePublicDnsNamespaceCommandInput, CreatePublicDnsNamespaceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
86
93
  readonly input: CreatePublicDnsNamespaceCommandInput;
87
94
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
95
+ /**
96
+ * @public
97
+ */
88
98
  constructor(input: CreatePublicDnsNamespaceCommandInput);
89
99
  /**
90
100
  * @internal
91
101
  */
92
102
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ServiceDiscoveryClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreatePublicDnsNamespaceCommandInput, CreatePublicDnsNamespaceCommandOutput>;
103
+ /**
104
+ * @internal
105
+ */
93
106
  private serialize;
107
+ /**
108
+ * @internal
109
+ */
94
110
  private deserialize;
95
111
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateServiceRequest, CreateServiceResponse } from "../models/models_0";
5
5
  import { ServiceDiscoveryClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ServiceDiscoveryClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateServiceCommand}.
8
10
  */
9
11
  export interface CreateServiceCommandInput extends CreateServiceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateServiceCommand}.
13
17
  */
14
18
  export interface CreateServiceCommandOutput extends CreateServiceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a service. This action defines the configuration for the following entities:</p>
18
23
  * <ul>
19
24
  * <li>
@@ -66,6 +71,8 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
66
71
  * const response = await client.send(command);
67
72
  * ```
68
73
  *
74
+ * @param CreateServiceCommandInput - {@link CreateServiceCommandInput}
75
+ * @returns {@link CreateServiceCommandOutput}
69
76
  * @see {@link CreateServiceCommandInput} for command's `input` shape.
70
77
  * @see {@link CreateServiceCommandOutput} for command's `response` shape.
71
78
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
@@ -144,11 +151,20 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
144
151
  export declare class CreateServiceCommand extends $Command<CreateServiceCommandInput, CreateServiceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
145
152
  readonly input: CreateServiceCommandInput;
146
153
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
154
+ /**
155
+ * @public
156
+ */
147
157
  constructor(input: CreateServiceCommandInput);
148
158
  /**
149
159
  * @internal
150
160
  */
151
161
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ServiceDiscoveryClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateServiceCommandInput, CreateServiceCommandOutput>;
162
+ /**
163
+ * @internal
164
+ */
152
165
  private serialize;
166
+ /**
167
+ * @internal
168
+ */
153
169
  private deserialize;
154
170
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteNamespaceRequest, DeleteNamespaceResponse } from "../models/models_0";
5
5
  import { ServiceDiscoveryClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ServiceDiscoveryClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteNamespaceCommand}.
8
10
  */
9
11
  export interface DeleteNamespaceCommandInput extends DeleteNamespaceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteNamespaceCommand}.
13
17
  */
14
18
  export interface DeleteNamespaceCommandOutput extends DeleteNamespaceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a namespace from the current account. If the namespace still contains one or more
18
23
  * services, the request fails.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeleteNamespaceCommandOutput extends DeleteNamespaceResponse, _
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteNamespaceCommandInput - {@link DeleteNamespaceCommandInput}
35
+ * @returns {@link DeleteNamespaceCommandOutput}
29
36
  * @see {@link DeleteNamespaceCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteNamespaceCommandOutput} for command's `response` shape.
31
38
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
@@ -71,11 +78,20 @@ export interface DeleteNamespaceCommandOutput extends DeleteNamespaceResponse, _
71
78
  export declare class DeleteNamespaceCommand extends $Command<DeleteNamespaceCommandInput, DeleteNamespaceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
72
79
  readonly input: DeleteNamespaceCommandInput;
73
80
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
81
+ /**
82
+ * @public
83
+ */
74
84
  constructor(input: DeleteNamespaceCommandInput);
75
85
  /**
76
86
  * @internal
77
87
  */
78
88
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ServiceDiscoveryClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteNamespaceCommandInput, DeleteNamespaceCommandOutput>;
89
+ /**
90
+ * @internal
91
+ */
79
92
  private serialize;
93
+ /**
94
+ * @internal
95
+ */
80
96
  private deserialize;
81
97
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteServiceRequest, DeleteServiceResponse } from "../models/models_0";
5
5
  import { ServiceDiscoveryClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ServiceDiscoveryClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteServiceCommand}.
8
10
  */
9
11
  export interface DeleteServiceCommandInput extends DeleteServiceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteServiceCommand}.
13
17
  */
14
18
  export interface DeleteServiceCommandOutput extends DeleteServiceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a specified service. If the service still contains one or more registered instances,
18
23
  * the request fails.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeleteServiceCommandOutput extends DeleteServiceResponse, __Met
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteServiceCommandInput - {@link DeleteServiceCommandInput}
35
+ * @returns {@link DeleteServiceCommandOutput}
29
36
  * @see {@link DeleteServiceCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteServiceCommandOutput} for command's `response` shape.
31
38
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
@@ -63,11 +70,20 @@ export interface DeleteServiceCommandOutput extends DeleteServiceResponse, __Met
63
70
  export declare class DeleteServiceCommand extends $Command<DeleteServiceCommandInput, DeleteServiceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
64
71
  readonly input: DeleteServiceCommandInput;
65
72
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
73
+ /**
74
+ * @public
75
+ */
66
76
  constructor(input: DeleteServiceCommandInput);
67
77
  /**
68
78
  * @internal
69
79
  */
70
80
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ServiceDiscoveryClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteServiceCommandInput, DeleteServiceCommandOutput>;
81
+ /**
82
+ * @internal
83
+ */
71
84
  private serialize;
85
+ /**
86
+ * @internal
87
+ */
72
88
  private deserialize;
73
89
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeregisterInstanceRequest, DeregisterInstanceResponse } from "../models/models_0";
5
5
  import { ServiceDiscoveryClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ServiceDiscoveryClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeregisterInstanceCommand}.
8
10
  */
9
11
  export interface DeregisterInstanceCommandInput extends DeregisterInstanceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeregisterInstanceCommand}.
13
17
  */
14
18
  export interface DeregisterInstanceCommandOutput extends DeregisterInstanceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the
18
23
  * specified instance.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeregisterInstanceCommandOutput extends DeregisterInstanceRespo
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeregisterInstanceCommandInput - {@link DeregisterInstanceCommandInput}
35
+ * @returns {@link DeregisterInstanceCommandOutput}
29
36
  * @see {@link DeregisterInstanceCommandInput} for command's `input` shape.
30
37
  * @see {@link DeregisterInstanceCommandOutput} for command's `response` shape.
31
38
  * @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
@@ -76,11 +83,20 @@ export interface DeregisterInstanceCommandOutput extends DeregisterInstanceRespo
76
83
  export declare class DeregisterInstanceCommand extends $Command<DeregisterInstanceCommandInput, DeregisterInstanceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
77
84
  readonly input: DeregisterInstanceCommandInput;
78
85
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
86
+ /**
87
+ * @public
88
+ */
79
89
  constructor(input: DeregisterInstanceCommandInput);
80
90
  /**
81
91
  * @internal
82
92
  */
83
93
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ServiceDiscoveryClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeregisterInstanceCommandInput, DeregisterInstanceCommandOutput>;
94
+ /**
95
+ * @internal
96
+ */
84
97
  private serialize;
98
+ /**
99
+ * @internal
100
+ */
85
101
  private deserialize;
86
102
  }