@aws-sdk/client-servicediscovery 3.36.0 → 3.36.1

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 (74) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/dist-cjs/ServiceDiscovery.js +0 -8
  3. package/dist-cjs/ServiceDiscoveryClient.js +0 -13
  4. package/dist-cjs/commands/CreateHttpNamespaceCommand.js +0 -28
  5. package/dist-cjs/commands/CreatePrivateDnsNamespaceCommand.js +0 -30
  6. package/dist-cjs/commands/CreatePublicDnsNamespaceCommand.js +0 -29
  7. package/dist-cjs/commands/CreateServiceCommand.js +0 -64
  8. package/dist-cjs/commands/DeleteNamespaceCommand.js +0 -25
  9. package/dist-cjs/commands/DeleteServiceCommand.js +0 -25
  10. package/dist-cjs/commands/DeregisterInstanceCommand.js +0 -25
  11. package/dist-cjs/commands/DiscoverInstancesCommand.js +0 -26
  12. package/dist-cjs/commands/GetInstanceCommand.js +0 -24
  13. package/dist-cjs/commands/GetInstancesHealthStatusCommand.js +0 -29
  14. package/dist-cjs/commands/GetNamespaceCommand.js +0 -24
  15. package/dist-cjs/commands/GetOperationCommand.js +0 -28
  16. package/dist-cjs/commands/GetServiceCommand.js +0 -24
  17. package/dist-cjs/commands/ListInstancesCommand.js +0 -24
  18. package/dist-cjs/commands/ListNamespacesCommand.js +0 -24
  19. package/dist-cjs/commands/ListOperationsCommand.js +0 -24
  20. package/dist-cjs/commands/ListServicesCommand.js +0 -24
  21. package/dist-cjs/commands/ListTagsForResourceCommand.js +0 -24
  22. package/dist-cjs/commands/RegisterInstanceCommand.js +0 -63
  23. package/dist-cjs/commands/TagResourceCommand.js +0 -24
  24. package/dist-cjs/commands/UntagResourceCommand.js +0 -24
  25. package/dist-cjs/commands/UpdateHttpNamespaceCommand.js +0 -25
  26. package/dist-cjs/commands/UpdateInstanceCustomHealthStatusCommand.js +0 -28
  27. package/dist-cjs/commands/UpdatePrivateDnsNamespaceCommand.js +0 -25
  28. package/dist-cjs/commands/UpdatePublicDnsNamespaceCommand.js +0 -25
  29. package/dist-cjs/commands/UpdateServiceCommand.js +0 -48
  30. package/dist-cjs/models/models_0.js +0 -300
  31. package/dist-cjs/pagination/GetInstancesHealthStatusPaginator.js +0 -10
  32. package/dist-cjs/pagination/ListInstancesPaginator.js +0 -10
  33. package/dist-cjs/pagination/ListNamespacesPaginator.js +0 -10
  34. package/dist-cjs/pagination/ListOperationsPaginator.js +0 -10
  35. package/dist-cjs/pagination/ListServicesPaginator.js +0 -10
  36. package/dist-cjs/protocols/Aws_json1_1.js +0 -5
  37. package/dist-cjs/runtimeConfig.browser.js +1 -5
  38. package/dist-cjs/runtimeConfig.js +1 -5
  39. package/dist-cjs/runtimeConfig.native.js +0 -3
  40. package/dist-cjs/runtimeConfig.shared.js +0 -3
  41. package/dist-types/ts3.4/ServiceDiscovery.d.ts +27 -225
  42. package/dist-types/ts3.4/ServiceDiscoveryClient.d.ts +24 -94
  43. package/dist-types/ts3.4/commands/CreateHttpNamespaceCommand.d.ts +2 -24
  44. package/dist-types/ts3.4/commands/CreatePrivateDnsNamespaceCommand.d.ts +2 -26
  45. package/dist-types/ts3.4/commands/CreatePublicDnsNamespaceCommand.d.ts +2 -25
  46. package/dist-types/ts3.4/commands/CreateServiceCommand.d.ts +2 -60
  47. package/dist-types/ts3.4/commands/DeleteNamespaceCommand.d.ts +2 -21
  48. package/dist-types/ts3.4/commands/DeleteServiceCommand.d.ts +2 -21
  49. package/dist-types/ts3.4/commands/DeregisterInstanceCommand.d.ts +2 -21
  50. package/dist-types/ts3.4/commands/DiscoverInstancesCommand.d.ts +2 -22
  51. package/dist-types/ts3.4/commands/GetInstanceCommand.d.ts +2 -20
  52. package/dist-types/ts3.4/commands/GetInstancesHealthStatusCommand.d.ts +2 -25
  53. package/dist-types/ts3.4/commands/GetNamespaceCommand.d.ts +2 -20
  54. package/dist-types/ts3.4/commands/GetOperationCommand.d.ts +2 -24
  55. package/dist-types/ts3.4/commands/GetServiceCommand.d.ts +2 -20
  56. package/dist-types/ts3.4/commands/ListInstancesCommand.d.ts +2 -20
  57. package/dist-types/ts3.4/commands/ListNamespacesCommand.d.ts +2 -20
  58. package/dist-types/ts3.4/commands/ListOperationsCommand.d.ts +2 -20
  59. package/dist-types/ts3.4/commands/ListServicesCommand.d.ts +2 -20
  60. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +2 -20
  61. package/dist-types/ts3.4/commands/RegisterInstanceCommand.d.ts +2 -59
  62. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +2 -20
  63. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -20
  64. package/dist-types/ts3.4/commands/UpdateHttpNamespaceCommand.d.ts +2 -21
  65. package/dist-types/ts3.4/commands/UpdateInstanceCustomHealthStatusCommand.d.ts +2 -24
  66. package/dist-types/ts3.4/commands/UpdatePrivateDnsNamespaceCommand.d.ts +2 -21
  67. package/dist-types/ts3.4/commands/UpdatePublicDnsNamespaceCommand.d.ts +2 -21
  68. package/dist-types/ts3.4/commands/UpdateServiceCommand.d.ts +2 -44
  69. package/dist-types/ts3.4/models/models_0.d.ts +363 -2229
  70. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  71. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  72. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  73. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  74. package/package.json +3 -3
@@ -1,333 +1,188 @@
1
1
  import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
- /**
3
- * <p>A custom key-value pair that's associated with a resource.</p>
4
- */
2
+
5
3
  export interface Tag {
6
- /**
7
- * <p>The key identifier, or name, of the tag.</p>
8
- */
4
+
9
5
  Key: string | undefined;
10
- /**
11
- * <p>The string value that's associated with the key of the tag. You can set the value of a tag to an empty string,
12
- * but you can't set the value of a tag to null.</p>
13
- */
6
+
14
7
  Value: string | undefined;
15
8
  }
16
9
  export declare namespace Tag {
17
- /**
18
- * @internal
19
- */
10
+
20
11
  const filterSensitiveLog: (obj: Tag) => any;
21
12
  }
22
13
  export interface CreateHttpNamespaceRequest {
23
- /**
24
- * <p>The name that you want to assign to this namespace.</p>
25
- */
14
+
26
15
  Name: string | undefined;
27
- /**
28
- * <p>A unique string that identifies the request and that allows failed <code>CreateHttpNamespace</code> requests to
29
- * be retried without the risk of running the operation twice. <code>CreatorRequestId</code> can be any unique string
30
- * (for example, a date/time stamp).</p>
31
- */
16
+
32
17
  CreatorRequestId?: string;
33
- /**
34
- * <p>A description for the namespace.</p>
35
- */
18
+
36
19
  Description?: string;
37
- /**
38
- * <p>The tags to add to the namespace. Each tag consists of a key and an optional value that you define.
39
- * Tags keys can be up to 128 characters in length, and tag values can be up to 256
40
- * characters in length.</p>
41
- */
20
+
42
21
  Tags?: Tag[];
43
22
  }
44
23
  export declare namespace CreateHttpNamespaceRequest {
45
- /**
46
- * @internal
47
- */
24
+
48
25
  const filterSensitiveLog: (obj: CreateHttpNamespaceRequest) => any;
49
26
  }
50
27
  export interface CreateHttpNamespaceResponse {
51
- /**
52
- * <p>A value that you can use to determine whether the request completed successfully.
53
- * To get the status of the operation, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html">GetOperation</a>.</p>
54
- */
28
+
55
29
  OperationId?: string;
56
30
  }
57
31
  export declare namespace CreateHttpNamespaceResponse {
58
- /**
59
- * @internal
60
- */
32
+
61
33
  const filterSensitiveLog: (obj: CreateHttpNamespaceResponse) => any;
62
34
  }
63
- /**
64
- * <p>The operation is already in progress.</p>
65
- */
35
+
66
36
  export interface DuplicateRequest extends __SmithyException, $MetadataBearer {
67
37
  name: "DuplicateRequest";
68
38
  $fault: "client";
69
39
  Message?: string;
70
- /**
71
- * <p>The ID of the operation that's already in progress.</p>
72
- */
40
+
73
41
  DuplicateOperationId?: string;
74
42
  }
75
43
  export declare namespace DuplicateRequest {
76
- /**
77
- * @internal
78
- */
44
+
79
45
  const filterSensitiveLog: (obj: DuplicateRequest) => any;
80
46
  }
81
- /**
82
- * <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value might
83
- * be outside the allowed range, or a string value might exceed length constraints.</p>
84
- */
47
+
85
48
  export interface InvalidInput extends __SmithyException, $MetadataBearer {
86
49
  name: "InvalidInput";
87
50
  $fault: "client";
88
51
  Message?: string;
89
52
  }
90
53
  export declare namespace InvalidInput {
91
- /**
92
- * @internal
93
- */
54
+
94
55
  const filterSensitiveLog: (obj: InvalidInput) => any;
95
56
  }
96
- /**
97
- * <p>The namespace that you're trying to create already exists.</p>
98
- */
57
+
99
58
  export interface NamespaceAlreadyExists extends __SmithyException, $MetadataBearer {
100
59
  name: "NamespaceAlreadyExists";
101
60
  $fault: "client";
102
61
  Message?: string;
103
- /**
104
- * <p>The <code>CreatorRequestId</code> that was used to create the namespace.</p>
105
- */
62
+
106
63
  CreatorRequestId?: string;
107
- /**
108
- * <p>The ID of the existing namespace.</p>
109
- */
64
+
110
65
  NamespaceId?: string;
111
66
  }
112
67
  export declare namespace NamespaceAlreadyExists {
113
- /**
114
- * @internal
115
- */
68
+
116
69
  const filterSensitiveLog: (obj: NamespaceAlreadyExists) => any;
117
70
  }
118
- /**
119
- * <p>The resource can't be created because you've reached the quota on the number of resources.</p>
120
- */
71
+
121
72
  export interface ResourceLimitExceeded extends __SmithyException, $MetadataBearer {
122
73
  name: "ResourceLimitExceeded";
123
74
  $fault: "client";
124
75
  Message?: string;
125
76
  }
126
77
  export declare namespace ResourceLimitExceeded {
127
- /**
128
- * @internal
129
- */
78
+
130
79
  const filterSensitiveLog: (obj: ResourceLimitExceeded) => any;
131
80
  }
132
- /**
133
- * <p>The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource
134
- * is 50.</p>
135
- */
81
+
136
82
  export interface TooManyTagsException extends __SmithyException, $MetadataBearer {
137
83
  name: "TooManyTagsException";
138
84
  $fault: "client";
139
85
  Message?: string;
140
- /**
141
- * <p>The name of the resource.</p>
142
- */
86
+
143
87
  ResourceName?: string;
144
88
  }
145
89
  export declare namespace TooManyTagsException {
146
- /**
147
- * @internal
148
- */
90
+
149
91
  const filterSensitiveLog: (obj: TooManyTagsException) => any;
150
92
  }
151
- /**
152
- * <p>Start of Authority (SOA) properties for a
153
- * public or private DNS namespace.</p>
154
- */
93
+
155
94
  export interface SOA {
156
- /**
157
- * <p>The time to live (TTL) for purposes of
158
- * negative caching.</p>
159
- */
95
+
160
96
  TTL: number | undefined;
161
97
  }
162
98
  export declare namespace SOA {
163
- /**
164
- * @internal
165
- */
99
+
166
100
  const filterSensitiveLog: (obj: SOA) => any;
167
101
  }
168
- /**
169
- * <p>DNS properties for the private DNS
170
- * namespace.</p>
171
- */
102
+
172
103
  export interface PrivateDnsPropertiesMutable {
173
- /**
174
- * <p>Fields for the Start of Authority (SOA)
175
- * record for the hosted zone for the private DNS namespace.</p>
176
- */
104
+
177
105
  SOA: SOA | undefined;
178
106
  }
179
107
  export declare namespace PrivateDnsPropertiesMutable {
180
- /**
181
- * @internal
182
- */
108
+
183
109
  const filterSensitiveLog: (obj: PrivateDnsPropertiesMutable) => any;
184
110
  }
185
- /**
186
- * <p>DNS properties for the private DNS
187
- * namespace.</p>
188
- */
111
+
189
112
  export interface PrivateDnsNamespaceProperties {
190
- /**
191
- * <p>DNS properties for the private DNS
192
- * namespace.</p>
193
- */
113
+
194
114
  DnsProperties: PrivateDnsPropertiesMutable | undefined;
195
115
  }
196
116
  export declare namespace PrivateDnsNamespaceProperties {
197
- /**
198
- * @internal
199
- */
117
+
200
118
  const filterSensitiveLog: (obj: PrivateDnsNamespaceProperties) => any;
201
119
  }
202
120
  export interface CreatePrivateDnsNamespaceRequest {
203
- /**
204
- * <p>The name that you want to assign to this namespace. When you create a private DNS namespace, Cloud Map
205
- * automatically creates an Amazon Route 53 private hosted zone that has the same name as the namespace.</p>
206
- */
121
+
207
122
  Name: string | undefined;
208
- /**
209
- * <p>A unique string that identifies the request and that allows failed <code>CreatePrivateDnsNamespace</code>
210
- * requests to be retried without the risk of running the operation twice. <code>CreatorRequestId</code> can be any
211
- * unique string (for example, a date/timestamp).</p>
212
- */
123
+
213
124
  CreatorRequestId?: string;
214
- /**
215
- * <p>A description for the namespace.</p>
216
- */
125
+
217
126
  Description?: string;
218
- /**
219
- * <p>The ID of the Amazon VPC that you want to associate the namespace with.</p>
220
- */
127
+
221
128
  Vpc: string | undefined;
222
- /**
223
- * <p>The tags to add to the namespace. Each tag consists of a key and an optional value that you define.
224
- * Tags keys can be up to 128 characters in length, and tag values can be up to 256
225
- * characters in length.</p>
226
- */
129
+
227
130
  Tags?: Tag[];
228
- /**
229
- * <p>Properties for the private DNS
230
- * namespace.</p>
231
- */
131
+
232
132
  Properties?: PrivateDnsNamespaceProperties;
233
133
  }
234
134
  export declare namespace CreatePrivateDnsNamespaceRequest {
235
- /**
236
- * @internal
237
- */
135
+
238
136
  const filterSensitiveLog: (obj: CreatePrivateDnsNamespaceRequest) => any;
239
137
  }
240
138
  export interface CreatePrivateDnsNamespaceResponse {
241
- /**
242
- * <p>A value that you can use to determine whether the request completed successfully.
243
- * To get the status of the operation, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html">GetOperation</a>.</p>
244
- */
139
+
245
140
  OperationId?: string;
246
141
  }
247
142
  export declare namespace CreatePrivateDnsNamespaceResponse {
248
- /**
249
- * @internal
250
- */
143
+
251
144
  const filterSensitiveLog: (obj: CreatePrivateDnsNamespaceResponse) => any;
252
145
  }
253
- /**
254
- * <p>DNS properties for the public DNS
255
- * namespace.</p>
256
- */
146
+
257
147
  export interface PublicDnsPropertiesMutable {
258
- /**
259
- * <p>Start of Authority (SOA) record for the
260
- * hosted zone for the public DNS namespace.</p>
261
- */
148
+
262
149
  SOA: SOA | undefined;
263
150
  }
264
151
  export declare namespace PublicDnsPropertiesMutable {
265
- /**
266
- * @internal
267
- */
152
+
268
153
  const filterSensitiveLog: (obj: PublicDnsPropertiesMutable) => any;
269
154
  }
270
- /**
271
- * <p>DNS properties for the public DNS
272
- * namespace.</p>
273
- */
155
+
274
156
  export interface PublicDnsNamespaceProperties {
275
- /**
276
- * <p>DNS properties for the public DNS
277
- * namespace.</p>
278
- */
157
+
279
158
  DnsProperties: PublicDnsPropertiesMutable | undefined;
280
159
  }
281
160
  export declare namespace PublicDnsNamespaceProperties {
282
- /**
283
- * @internal
284
- */
161
+
285
162
  const filterSensitiveLog: (obj: PublicDnsNamespaceProperties) => any;
286
163
  }
287
164
  export interface CreatePublicDnsNamespaceRequest {
288
- /**
289
- * <p>The name that you want to assign to this namespace.</p>
290
- */
165
+
291
166
  Name: string | undefined;
292
- /**
293
- * <p>A unique string that identifies the request and that allows failed <code>CreatePublicDnsNamespace</code>
294
- * requests to be retried without the risk of running the operation twice. <code>CreatorRequestId</code> can be any
295
- * unique string (for example, a date/timestamp).</p>
296
- */
167
+
297
168
  CreatorRequestId?: string;
298
- /**
299
- * <p>A description for the namespace.</p>
300
- */
169
+
301
170
  Description?: string;
302
- /**
303
- * <p>The tags to add to the namespace. Each tag consists of a key and an optional value that you define.
304
- * Tags keys can be up to 128 characters in length, and tag values can be up to 256
305
- * characters in length.</p>
306
- */
171
+
307
172
  Tags?: Tag[];
308
- /**
309
- * <p>Properties for the public DNS
310
- * namespace.</p>
311
- */
173
+
312
174
  Properties?: PublicDnsNamespaceProperties;
313
175
  }
314
176
  export declare namespace CreatePublicDnsNamespaceRequest {
315
- /**
316
- * @internal
317
- */
177
+
318
178
  const filterSensitiveLog: (obj: CreatePublicDnsNamespaceRequest) => any;
319
179
  }
320
180
  export interface CreatePublicDnsNamespaceResponse {
321
- /**
322
- * <p>A value that you can use to determine whether the request completed successfully. To get the status of the
323
- * operation, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html">GetOperation</a>.</p>
324
- */
181
+
325
182
  OperationId?: string;
326
183
  }
327
184
  export declare namespace CreatePublicDnsNamespaceResponse {
328
- /**
329
- * @internal
330
- */
185
+
331
186
  const filterSensitiveLog: (obj: CreatePublicDnsNamespaceResponse) => any;
332
187
  }
333
188
  export declare enum RecordType {
@@ -336,222 +191,32 @@ export declare enum RecordType {
336
191
  CNAME = "CNAME",
337
192
  SRV = "SRV"
338
193
  }
339
- /**
340
- * <p>A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create when you
341
- * register an instance.</p>
342
- */
194
+
343
195
  export interface DnsRecord {
344
- /**
345
- * <p>The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries. You
346
- * can specify values for <code>Type</code> in the following combinations:</p>
347
- * <ul>
348
- * <li>
349
- * <p>
350
- * <b>
351
- * <code>A</code>
352
- * </b>
353
- * </p>
354
- * </li>
355
- * <li>
356
- * <p>
357
- * <b>
358
- * <code>AAAA</code>
359
- * </b>
360
- * </p>
361
- * </li>
362
- * <li>
363
- * <p>
364
- * <b>
365
- * <code>A</code>
366
- * </b> and <b>
367
- * <code>AAAA</code>
368
- * </b>
369
- * </p>
370
- * </li>
371
- * <li>
372
- * <p>
373
- * <b>
374
- * <code>SRV</code>
375
- * </b>
376
- * </p>
377
- * </li>
378
- * <li>
379
- * <p>
380
- * <b>
381
- * <code>CNAME</code>
382
- * </b>
383
- * </p>
384
- * </li>
385
- * </ul>
386
- * <p>If you want Cloud Map to create a Route 53 alias record when you register an instance, specify <code>A</code> or
387
- * <code>AAAA</code> for <code>Type</code>.</p>
388
- * <p>You specify other settings, such as the IP address for <code>A</code> and <code>AAAA</code> records, when you
389
- * register an instance. For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html">RegisterInstance</a>.</p>
390
- * <p>The following values are supported:</p>
391
- * <dl>
392
- * <dt>A</dt>
393
- * <dd>
394
- * <p>Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.</p>
395
- * </dd>
396
- * <dt>AAAA</dt>
397
- * <dd>
398
- * <p>Route 53 returns the IP address of the resource in IPv6 format, such as
399
- * 2001:0db8:85a3:0000:0000:abcd:0001:2345.</p>
400
- * </dd>
401
- * <dt>CNAME</dt>
402
- * <dd>
403
- * <p>Route 53 returns the domain name of the resource, such as www.example.com. Note the following:</p>
404
- * <ul>
405
- * <li>
406
- * <p>You specify the domain name that you want to route traffic to when you register an instance. For more
407
- * information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html#cloudmap-RegisterInstance-request-Attributes">Attributes</a> in the topic <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html">RegisterInstance</a>.</p>
408
- * </li>
409
- * <li>
410
- * <p>You must specify <code>WEIGHTED</code> for the value of <code>RoutingPolicy</code>.</p>
411
- * </li>
412
- * <li>
413
- * <p>You can't specify both <code>CNAME</code> for <code>Type</code> and settings for
414
- * <code>HealthCheckConfig</code>. If you do, the request will fail with an <code>InvalidInput</code>
415
- * error.</p>
416
- * </li>
417
- * </ul>
418
- * </dd>
419
- * <dt>SRV</dt>
420
- * <dd>
421
- * <p>Route 53 returns the value for an <code>SRV</code> record. The value for an <code>SRV</code> record uses the
422
- * following values:</p>
423
- * <p>
424
- * <code>priority weight port service-hostname</code>
425
- * </p>
426
- * <p>Note the following about the values:</p>
427
- * <ul>
428
- * <li>
429
- * <p>The values of <code>priority</code> and <code>weight</code> are both set to <code>1</code> and can't be
430
- * changed. </p>
431
- * </li>
432
- * <li>
433
- * <p>The value of <code>port</code> comes from the value that you specify for the <code>AWS_INSTANCE_PORT</code>
434
- * attribute when you submit a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html">RegisterInstance</a> request.</p>
435
- * </li>
436
- * <li>
437
- * <p>The value of <code>service-hostname</code> is a concatenation of the following values:</p>
438
- * <ul>
439
- * <li>
440
- * <p>The value that you specify for <code>InstanceId</code> when you register an instance.</p>
441
- * </li>
442
- * <li>
443
- * <p>The name of the service.</p>
444
- * </li>
445
- * <li>
446
- * <p>The name of the namespace. </p>
447
- * </li>
448
- * </ul>
449
- * <p>For example, if the value of <code>InstanceId</code> is <code>test</code>, the name of the service is
450
- * <code>backend</code>, and the name of the namespace is <code>example.com</code>, the value of
451
- * <code>service-hostname</code> is the following:</p>
452
- * <p>
453
- * <code>test.backend.example.com</code>
454
- * </p>
455
- * </li>
456
- * </ul>
457
- * <p>If you specify settings for an <code>SRV</code> record, note the following:</p>
458
- * <ul>
459
- * <li>
460
- * <p>If you specify values for <code>AWS_INSTANCE_IPV4</code>, <code>AWS_INSTANCE_IPV6</code>, or both in the
461
- * <code>RegisterInstance</code> request, Cloud Map automatically creates <code>A</code> and/or <code>AAAA</code>
462
- * records that have the same name as the value of <code>service-hostname</code> in the <code>SRV</code> record.
463
- * You can ignore these records.</p>
464
- * </li>
465
- * <li>
466
- * <p>If you're using a system that requires a specific <code>SRV</code> format, such as HAProxy, see the <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html#cloudmap-CreateService-request-Name">Name</a> element in the documentation about <code>CreateService</code> for information about how to
467
- * specify the correct name format.</p>
468
- * </li>
469
- * </ul>
470
- * </dd>
471
- * </dl>
472
- */
196
+
473
197
  Type: RecordType | string | undefined;
474
- /**
475
- * <p>The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.</p>
476
- * <note>
477
- * <p>Alias records don't include a TTL because Route 53 uses the TTL for the Amazon Web Services resource that an alias record routes
478
- * traffic to. If you include the <code>AWS_ALIAS_DNS_NAME</code> attribute when you submit a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html">RegisterInstance</a> request, the
479
- * <code>TTL</code> value is ignored. Always specify a TTL for the service; you can use a service to register
480
- * instances that create either alias or non-alias records.</p>
481
- * </note>
482
- */
198
+
483
199
  TTL: number | undefined;
484
200
  }
485
201
  export declare namespace DnsRecord {
486
- /**
487
- * @internal
488
- */
202
+
489
203
  const filterSensitiveLog: (obj: DnsRecord) => any;
490
204
  }
491
205
  export declare enum RoutingPolicy {
492
206
  MULTIVALUE = "MULTIVALUE",
493
207
  WEIGHTED = "WEIGHTED"
494
208
  }
495
- /**
496
- * <p>A complex type that contains information about the Amazon Route 53 DNS records that you want Cloud Map to create when
497
- * you register an instance.</p>
498
- */
209
+
499
210
  export interface DnsConfig {
500
- /**
501
- * @deprecated
502
- *
503
- * <p>The ID of the namespace to use for DNS configuration.</p>
504
- */
211
+
505
212
  NamespaceId?: string;
506
- /**
507
- * <p>The routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates when you register an
508
- * instance and specify this service.</p>
509
- * <note>
510
- * <p>If you want to use this service to register instances that create alias records, specify <code>WEIGHTED</code>
511
- * for the routing policy.</p>
512
- * </note>
513
- * <p>You can specify the following values:</p>
514
- * <dl>
515
- * <dt>MULTIVALUE</dt>
516
- * <dd>
517
- * <p>If you define a health check for the service and the health check is healthy, Route 53 returns the applicable
518
- * value for up to eight instances.</p>
519
- * <p>For example, suppose that the service includes configurations for one <code>A</code> record and a health
520
- * check. You use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to
521
- * eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP
522
- * addresses for all of the healthy instances.</p>
523
- * <p>If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns
524
- * the values for up to eight instances.</p>
525
- * <p>For more information about the multivalue routing policy, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html#routing-policy-multivalue">Multivalue Answer
526
- * Routing</a> in the <i>Route 53 Developer Guide</i>.</p>
527
- * </dd>
528
- * <dt>WEIGHTED</dt>
529
- * <dd>
530
- * <p>Route 53 returns the applicable value from one randomly selected instance from among the instances that you
531
- * registered using the same service. Currently, all records have the same weight, so you can't route more or less
532
- * traffic to any instances.</p>
533
- * <p>For example, suppose that the service includes configurations for one <code>A</code> record and a health
534
- * check. You use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one
535
- * randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS
536
- * queries as if all of the instances were healthy.</p>
537
- * <p>If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns
538
- * the applicable value for one randomly selected instance.</p>
539
- * <p>For more information about the weighted routing policy, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html#routing-policy-weighted">Weighted Routing</a> in the
540
- * <i>Route 53 Developer Guide</i>.</p>
541
- * </dd>
542
- * </dl>
543
- */
213
+
544
214
  RoutingPolicy?: RoutingPolicy | string;
545
- /**
546
- * <p>An array that contains one <code>DnsRecord</code> object for each Route 53 DNS record that you want Cloud Map to
547
- * create when you register an instance.</p>
548
- */
215
+
549
216
  DnsRecords: DnsRecord[] | undefined;
550
217
  }
551
218
  export declare namespace DnsConfig {
552
- /**
553
- * @internal
554
- */
219
+
555
220
  const filterSensitiveLog: (obj: DnsConfig) => any;
556
221
  }
557
222
  export declare enum HealthCheckType {
@@ -559,283 +224,53 @@ export declare enum HealthCheckType {
559
224
  HTTPS = "HTTPS",
560
225
  TCP = "TCP"
561
226
  }
562
- /**
563
- * <p>
564
- * <i>Public DNS and HTTP namespaces only.</i> A complex type that contains settings for an optional
565
- * health check. If you specify settings for a health check, Cloud Map associates the health check with the records
566
- * that you specify in <code>DnsConfig</code>.</p>
567
- * <important>
568
- * <p>If you specify a health check configuration, you can specify either <code>HealthCheckCustomConfig</code> or
569
- * <code>HealthCheckConfig</code> but not both.</p>
570
- * </important>
571
- * <p>Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For information about
572
- * pricing for health checks, see <a href="http://aws.amazon.com/route53/pricing/">Amazon Route 53 Pricing</a>.</p>
573
- * <p>Note the following about configuring health checks.</p>
574
- * <dl>
575
- * <dt>A and AAAA records</dt>
576
- * <dd>
577
- * <p>If <code>DnsConfig</code> includes configurations for both <code>A</code> and <code>AAAA</code> records,
578
- * Cloud Map creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint
579
- * tthat's specified by the IPv4 address is unhealthy, Route 53 considers both the <code>A</code> and <code>AAAA</code>
580
- * records to be unhealthy. </p>
581
- * </dd>
582
- * <dt>CNAME records</dt>
583
- * <dd>
584
- * <p>You can't specify settings for <code>HealthCheckConfig</code> when the <code>DNSConfig</code> includes
585
- * <code>CNAME</code> for the value of <code>Type</code>. If you do, the <code>CreateService</code> request will
586
- * fail with an <code>InvalidInput</code> error.</p>
587
- * </dd>
588
- * <dt>Request interval</dt>
589
- * <dd>
590
- * <p>A Route 53 health checker in each health-checking Amazon Web Services Region sends a health check request to an endpoint every
591
- * 30 seconds. On average, your endpoint receives a health check request about every two seconds. However, health
592
- * checkers don't coordinate with one another. Therefore, you might sometimes see several requests in one second
593
- * that's followed by a few seconds with no health checks at all.</p>
594
- * </dd>
595
- * <dt>Health checking regions</dt>
596
- * <dd>
597
- * <p>Health checkers perform checks from all Route 53 health-checking Regions. For a list of the current Regions, see
598
- * <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions">Regions</a>.</p>
599
- * </dd>
600
- * <dt>Alias records</dt>
601
- * <dd>
602
- * <p>When you register an instance, if you include the <code>AWS_ALIAS_DNS_NAME</code> attribute, Cloud Map
603
- * creates a Route 53 alias record. Note the following:</p>
604
- * <ul>
605
- * <li>
606
- * <p>Route 53 automatically sets <code>EvaluateTargetHealth</code> to true for alias records. When
607
- * <code>EvaluateTargetHealth</code> is true, the alias record inherits the health of the referenced Amazon Web Services
608
- * resource. such as an ELB load balancer. For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-EvaluateTargetHealth">EvaluateTargetHealth</a>.</p>
609
- * </li>
610
- * <li>
611
- * <p>If you include <code>HealthCheckConfig</code> and then use the service to register an instance that creates
612
- * an alias record, Route 53 doesn't create the health check.</p>
613
- * </li>
614
- * </ul>
615
- * </dd>
616
- * <dt>Charges for health checks</dt>
617
- * <dd>
618
- * <p>Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For information about pricing for
619
- * health checks, see <a href="http://aws.amazon.com/route53/pricing/">Amazon Route 53 Pricing</a>.</p>
620
- * </dd>
621
- * </dl>
622
- */
227
+
623
228
  export interface HealthCheckConfig {
624
- /**
625
- * <p>The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is
626
- * healthy.</p>
627
- * <important>
628
- * <p>You can't change the value of <code>Type</code> after you create a health check.</p>
629
- * </important>
630
- * <p>You can create the following types of health checks:</p>
631
- * <ul>
632
- * <li>
633
- * <p>
634
- * <b>HTTP</b>: Route 53 tries to establish a TCP connection. If successful, Route 53 submits
635
- * an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.</p>
636
- * </li>
637
- * <li>
638
- * <p>
639
- * <b>HTTPS</b>: Route 53 tries to establish a TCP connection. If successful, Route 53
640
- * submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.</p>
641
- * <important>
642
- * <p>If you specify HTTPS for the value of <code>Type</code>, the endpoint must support TLS v1.0 or later.</p>
643
- * </important>
644
- * </li>
645
- * <li>
646
- * <p>
647
- * <b>TCP</b>: Route 53 tries to establish a TCP connection.</p>
648
- * <p>If you specify <code>TCP</code> for <code>Type</code>, don't specify a value for
649
- * <code>ResourcePath</code>.</p>
650
- * </li>
651
- * </ul>
652
- * <p>For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html">How Route 53 Determines Whether
653
- * an Endpoint Is Healthy</a> in the <i>Route 53 Developer Guide</i>.</p>
654
- */
229
+
655
230
  Type: HealthCheckType | string | undefined;
656
- /**
657
- * <p>The path that you want Route 53 to request when performing health checks. The path can be any value that your
658
- * endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint is healthy. An example file is
659
- * <code>/docs/route53-health-check.html</code>. Route 53 automatically adds the DNS name for the service. If you don't
660
- * specify a value for <code>ResourcePath</code>, the default value is <code>/</code>.</p>
661
- * <p>If you specify <code>TCP</code> for <code>Type</code>, you must <i>not</i> specify a value for
662
- * <code>ResourcePath</code>.</p>
663
- */
231
+
664
232
  ResourcePath?: string;
665
- /**
666
- * <p>The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current
667
- * status of the endpoint from unhealthy to healthy or the other way around. For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html">How Route 53
668
- * Determines Whether an Endpoint Is Healthy</a> in the <i>Route 53 Developer Guide</i>.</p>
669
- */
233
+
670
234
  FailureThreshold?: number;
671
235
  }
672
236
  export declare namespace HealthCheckConfig {
673
- /**
674
- * @internal
675
- */
237
+
676
238
  const filterSensitiveLog: (obj: HealthCheckConfig) => any;
677
239
  }
678
- /**
679
- * <p>A complex type that contains information about an optional custom health check. A custom health check, which
680
- * requires that you use a third-party health checker to evaluate the health of your resources, is useful in the
681
- * following circumstances:</p>
682
- * <ul>
683
- * <li>
684
- * <p>You can't use a health check that's defined by <code>HealthCheckConfig</code> because the resource isn't
685
- * available over the internet. For example, you can use a custom health check when the instance is in an Amazon VPC.
686
- * (To check the health of resources in a VPC, the health checker must also be in the VPC.)</p>
687
- * </li>
688
- * <li>
689
- * <p>You want to use a third-party health checker regardless of where your resources are located.</p>
690
- * </li>
691
- * </ul>
692
- * <important>
693
- * <p>If you specify a health check configuration, you can specify either <code>HealthCheckCustomConfig</code> or
694
- * <code>HealthCheckConfig</code> but not both.</p>
695
- * </important>
696
- * <p>To change the status of a custom health check, submit an <code>UpdateInstanceCustomHealthStatus</code> request.
697
- * Cloud Map doesn't monitor the status of the resource, it just keeps a record of the status specified in the most recent
698
- * <code>UpdateInstanceCustomHealthStatus</code> request.</p>
699
- * <p>Here's how custom health checks work:</p>
700
- * <ol>
701
- * <li>
702
- * <p>You create a service.</p>
703
- * </li>
704
- * <li>
705
- * <p>You register an instance.</p>
706
- * </li>
707
- * <li>
708
- * <p>You configure a third-party health checker to monitor the resource that's associated with the new instance. </p>
709
- * <note>
710
- * <p>Cloud Map doesn't check the health of the resource directly. </p>
711
- * </note>
712
- * </li>
713
- * <li>
714
- * <p>The third-party health-checker determines that the resource is unhealthy and notifies your application.</p>
715
- * </li>
716
- * <li>
717
- * <p>Your application submits an <code>UpdateInstanceCustomHealthStatus</code> request.</p>
718
- * </li>
719
- * <li>
720
- * <p>Cloud Map waits for 30 seconds.</p>
721
- * </li>
722
- * <li>
723
- * <p>If another <code>UpdateInstanceCustomHealthStatus</code> request doesn't arrive during that time to change the
724
- * status back to healthy, Cloud Map stops routing traffic to the resource.</p>
725
- * </li>
726
- * </ol>
727
- */
240
+
728
241
  export interface HealthCheckCustomConfig {
729
- /**
730
- * @deprecated
731
- *
732
- * <important>
733
- * <p>This parameter is no longer supported and is always set to 1. Cloud Map waits for approximately 30 seconds after
734
- * receiving an <code>UpdateInstanceCustomHealthStatus</code> request before changing the status of the service
735
- * instance.</p>
736
- * </important>
737
- * <p>The number of 30-second intervals that you want Cloud Map to wait after receiving an
738
- * <code>UpdateInstanceCustomHealthStatus</code> request before it changes the health status of a service
739
- * instance.</p>
740
- * <p>Sending a second or subsequent <code>UpdateInstanceCustomHealthStatus</code> request with the same value before
741
- * 30 seconds has passed doesn't accelerate the change. Cloud Map still waits <code>30</code> seconds after the first
742
- * request to make the change.</p>
743
- */
242
+
744
243
  FailureThreshold?: number;
745
244
  }
746
245
  export declare namespace HealthCheckCustomConfig {
747
- /**
748
- * @internal
749
- */
246
+
750
247
  const filterSensitiveLog: (obj: HealthCheckCustomConfig) => any;
751
248
  }
752
249
  export declare enum ServiceTypeOption {
753
250
  HTTP = "HTTP"
754
251
  }
755
252
  export interface CreateServiceRequest {
756
- /**
757
- * <p>The name that you want to assign to the service.</p>
758
- * <p>If you want Cloud Map to create an <code>SRV</code> record when you register an instance and you're using a
759
- * system that requires a specific <code>SRV</code> format, such as <a href="http://www.haproxy.org/">HAProxy</a>, specify the following for <code>Name</code>:</p>
760
- * <ul>
761
- * <li>
762
- * <p>Start the name with an underscore (_), such as <code>_exampleservice</code>.</p>
763
- * </li>
764
- * <li>
765
- * <p>End the name with <i>._protocol</i>, such as <code>._tcp</code>.</p>
766
- * </li>
767
- * </ul>
768
- * <p>When you register an instance, Cloud Map creates an <code>SRV</code> record and assigns a name to the record by
769
- * concatenating the service name and the namespace name (for example,</p>
770
- * <p>
771
- * <code>_exampleservice._tcp.example.com</code>).</p>
772
- * <note>
773
- * <p>For services that are accessible by DNS queries, you can't create multiple services with names that differ only
774
- * by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and can't be distinguished.
775
- * However, if you use a namespace that's only accessible by API calls, then you can create services that with names
776
- * that differ only by case.</p>
777
- * </note>
778
- */
253
+
779
254
  Name: string | undefined;
780
- /**
781
- * <p>The ID of the namespace that you want to use to create the service. The namespace ID must be specified, but it
782
- * can be specified either here or in the <code>DnsConfig</code> object.</p>
783
- */
255
+
784
256
  NamespaceId?: string;
785
- /**
786
- * <p>A unique string that identifies the request and that allows failed <code>CreateService</code> requests to be
787
- * retried without the risk of running the operation twice. <code>CreatorRequestId</code> can be any unique string (for
788
- * example, a date/timestamp).</p>
789
- */
257
+
790
258
  CreatorRequestId?: string;
791
- /**
792
- * <p>A description for the service.</p>
793
- */
259
+
794
260
  Description?: string;
795
- /**
796
- * <p>A complex type that contains information about the Amazon Route 53 records that you want Cloud Map to create when you
797
- * register an instance. </p>
798
- */
261
+
799
262
  DnsConfig?: DnsConfig;
800
- /**
801
- * <p>
802
- * <i>Public DNS and HTTP namespaces only.</i> A complex type that contains settings for an optional
803
- * Route 53 health check. If you specify settings for a health check, Cloud Map associates the health check with all the
804
- * Route 53 DNS records that you specify in <code>DnsConfig</code>.</p>
805
- * <important>
806
- * <p>If you specify a health check configuration, you can specify either <code>HealthCheckCustomConfig</code> or
807
- * <code>HealthCheckConfig</code> but not both.</p>
808
- * </important>
809
- * <p>For information about the charges for health checks, see <a href="http://aws.amazon.com/cloud-map/pricing/">Cloud Map Pricing</a>.</p>
810
- */
263
+
811
264
  HealthCheckConfig?: HealthCheckConfig;
812
- /**
813
- * <p>A complex type that contains information about an optional custom health check.</p>
814
- * <important>
815
- * <p>If you specify a health check configuration, you can specify either <code>HealthCheckCustomConfig</code> or
816
- * <code>HealthCheckConfig</code> but not both.</p>
817
- * </important>
818
- * <p>You can't add, update, or delete a <code>HealthCheckCustomConfig</code> configuration from an existing
819
- * service.</p>
820
- */
265
+
821
266
  HealthCheckCustomConfig?: HealthCheckCustomConfig;
822
- /**
823
- * <p>The tags to add to the service. Each tag consists of a key and an optional value that you define.
824
- * Tags keys can be up to 128 characters in length, and tag values can be up to 256
825
- * characters in length.</p>
826
- */
267
+
827
268
  Tags?: Tag[];
828
- /**
829
- * <p>If present, specifies that the service instances are only discoverable using the <code>DiscoverInstances</code>
830
- * API operation. No DNS records is registered for the service instances. The only valid value is
831
- * <code>HTTP</code>.</p>
832
- */
269
+
833
270
  Type?: ServiceTypeOption | string;
834
271
  }
835
272
  export declare namespace CreateServiceRequest {
836
- /**
837
- * @internal
838
- */
273
+
839
274
  const filterSensitiveLog: (obj: CreateServiceRequest) => any;
840
275
  }
841
276
  export declare enum ServiceType {
@@ -843,156 +278,77 @@ export declare enum ServiceType {
843
278
  DNS_HTTP = "DNS_HTTP",
844
279
  HTTP = "HTTP"
845
280
  }
846
- /**
847
- * <p>A complex type that contains information about the specified service.</p>
848
- */
281
+
849
282
  export interface Service {
850
- /**
851
- * <p>The ID that Cloud Map assigned to the service when you created it.</p>
852
- */
283
+
853
284
  Id?: string;
854
- /**
855
- * <p>The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.</p>
856
- */
285
+
857
286
  Arn?: string;
858
- /**
859
- * <p>The name of the service.</p>
860
- */
287
+
861
288
  Name?: string;
862
- /**
863
- * <p>The ID of the namespace that was used to create the service.</p>
864
- */
289
+
865
290
  NamespaceId?: string;
866
- /**
867
- * <p>The description of the service.</p>
868
- */
291
+
869
292
  Description?: string;
870
- /**
871
- * <p>The number of instances that are currently associated with the service. Instances that were previously
872
- * associated with the service but that are deleted aren't included in the count. The count might not reflect pending
873
- * registrations and deregistrations.</p>
874
- */
293
+
875
294
  InstanceCount?: number;
876
- /**
877
- * <p>A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create when you
878
- * register an instance.</p>
879
- */
295
+
880
296
  DnsConfig?: DnsConfig;
881
- /**
882
- * <p>Describes the systems that can be used to discover the service instances.</p>
883
- * <dl>
884
- * <dt>DNS_HTTP</dt>
885
- * <dd>
886
- * <p>The service instances can be discovered using either DNS queries or the <code>DiscoverInstances</code> API
887
- * operation.</p>
888
- * </dd>
889
- * <dt>HTTP</dt>
890
- * <dd>
891
- * <p>The service instances can only be discovered using the <code>DiscoverInstances</code> API operation.</p>
892
- * </dd>
893
- * <dt>DNS</dt>
894
- * <dd>
895
- * <p>Reserved.</p>
896
- * </dd>
897
- * </dl>
898
- */
297
+
899
298
  Type?: ServiceType | string;
900
- /**
901
- * <p>
902
- * <i>Public DNS and HTTP namespaces only.</i> A complex type that contains settings for an optional
903
- * health check. If you specify settings for a health check, Cloud Map associates the health check with the records
904
- * that you specify in <code>DnsConfig</code>.</p>
905
- * <p>For information about the charges for health checks, see <a href="http://aws.amazon.com/route53/pricing/">Amazon Route 53 Pricing</a>.</p>
906
- */
299
+
907
300
  HealthCheckConfig?: HealthCheckConfig;
908
- /**
909
- * <p>A complex type that contains information about an optional custom health check.</p>
910
- * <important>
911
- * <p>If you specify a health check configuration, you can specify either <code>HealthCheckCustomConfig</code> or
912
- * <code>HealthCheckConfig</code> but not both.</p>
913
- * </important>
914
- */
301
+
915
302
  HealthCheckCustomConfig?: HealthCheckCustomConfig;
916
- /**
917
- * <p>The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The value
918
- * of <code>CreateDate</code> is accurate to milliseconds. For example, the value <code>1516925490.087</code> represents
919
- * Friday, January 26, 2018 12:11:30.087 AM.</p>
920
- */
303
+
921
304
  CreateDate?: Date;
922
- /**
923
- * <p>A unique string that identifies the request and that allows failed requests to be retried without the risk of
924
- * running the operation twice. <code>CreatorRequestId</code> can be any unique string (for example, a
925
- * date/timestamp).</p>
926
- */
305
+
927
306
  CreatorRequestId?: string;
928
307
  }
929
308
  export declare namespace Service {
930
- /**
931
- * @internal
932
- */
309
+
933
310
  const filterSensitiveLog: (obj: Service) => any;
934
311
  }
935
312
  export interface CreateServiceResponse {
936
- /**
937
- * <p>A complex type that contains information about the new service.</p>
938
- */
313
+
939
314
  Service?: Service;
940
315
  }
941
316
  export declare namespace CreateServiceResponse {
942
- /**
943
- * @internal
944
- */
317
+
945
318
  const filterSensitiveLog: (obj: CreateServiceResponse) => any;
946
319
  }
947
- /**
948
- * <p>No namespace exists with the specified ID.</p>
949
- */
320
+
950
321
  export interface NamespaceNotFound extends __SmithyException, $MetadataBearer {
951
322
  name: "NamespaceNotFound";
952
323
  $fault: "client";
953
324
  Message?: string;
954
325
  }
955
326
  export declare namespace NamespaceNotFound {
956
- /**
957
- * @internal
958
- */
327
+
959
328
  const filterSensitiveLog: (obj: NamespaceNotFound) => any;
960
329
  }
961
- /**
962
- * <p>The service can't be created because a service with the same name already exists.</p>
963
- */
330
+
964
331
  export interface ServiceAlreadyExists extends __SmithyException, $MetadataBearer {
965
332
  name: "ServiceAlreadyExists";
966
333
  $fault: "client";
967
334
  Message?: string;
968
- /**
969
- * <p>The <code>CreatorRequestId</code> that was used to create the service.</p>
970
- */
335
+
971
336
  CreatorRequestId?: string;
972
- /**
973
- * <p>The ID of the existing service.</p>
974
- */
337
+
975
338
  ServiceId?: string;
976
339
  }
977
340
  export declare namespace ServiceAlreadyExists {
978
- /**
979
- * @internal
980
- */
341
+
981
342
  const filterSensitiveLog: (obj: ServiceAlreadyExists) => any;
982
343
  }
983
- /**
984
- * <p>The health check for the instance that's specified by <code>ServiceId</code> and <code>InstanceId</code> isn't a
985
- * custom health check. </p>
986
- */
344
+
987
345
  export interface CustomHealthNotFound extends __SmithyException, $MetadataBearer {
988
346
  name: "CustomHealthNotFound";
989
347
  $fault: "client";
990
348
  Message?: string;
991
349
  }
992
350
  export declare namespace CustomHealthNotFound {
993
- /**
994
- * @internal
995
- */
351
+
996
352
  const filterSensitiveLog: (obj: CustomHealthNotFound) => any;
997
353
  }
998
354
  export declare enum CustomHealthStatus {
@@ -1000,121 +356,81 @@ export declare enum CustomHealthStatus {
1000
356
  UNHEALTHY = "UNHEALTHY"
1001
357
  }
1002
358
  export interface DeleteNamespaceRequest {
1003
- /**
1004
- * <p>The ID of the namespace that you want to delete.</p>
1005
- */
359
+
1006
360
  Id: string | undefined;
1007
361
  }
1008
362
  export declare namespace DeleteNamespaceRequest {
1009
- /**
1010
- * @internal
1011
- */
363
+
1012
364
  const filterSensitiveLog: (obj: DeleteNamespaceRequest) => any;
1013
365
  }
1014
366
  export interface DeleteNamespaceResponse {
1015
- /**
1016
- * <p>A value that you can use to determine whether the request completed successfully.
1017
- * To get the status of the operation, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html">GetOperation</a>.</p>
1018
- */
367
+
1019
368
  OperationId?: string;
1020
369
  }
1021
370
  export declare namespace DeleteNamespaceResponse {
1022
- /**
1023
- * @internal
1024
- */
371
+
1025
372
  const filterSensitiveLog: (obj: DeleteNamespaceResponse) => any;
1026
373
  }
1027
- /**
1028
- * <p>The specified resource can't be deleted because it contains other resources. For example, you can't delete a
1029
- * service that contains any instances.</p>
1030
- */
374
+
1031
375
  export interface ResourceInUse extends __SmithyException, $MetadataBearer {
1032
376
  name: "ResourceInUse";
1033
377
  $fault: "client";
1034
378
  Message?: string;
1035
379
  }
1036
380
  export declare namespace ResourceInUse {
1037
- /**
1038
- * @internal
1039
- */
381
+
1040
382
  const filterSensitiveLog: (obj: ResourceInUse) => any;
1041
383
  }
1042
384
  export interface DeleteServiceRequest {
1043
- /**
1044
- * <p>The ID of the service that you want to delete.</p>
1045
- */
385
+
1046
386
  Id: string | undefined;
1047
387
  }
1048
388
  export declare namespace DeleteServiceRequest {
1049
- /**
1050
- * @internal
1051
- */
389
+
1052
390
  const filterSensitiveLog: (obj: DeleteServiceRequest) => any;
1053
391
  }
1054
392
  export interface DeleteServiceResponse {
1055
393
  }
1056
394
  export declare namespace DeleteServiceResponse {
1057
- /**
1058
- * @internal
1059
- */
395
+
1060
396
  const filterSensitiveLog: (obj: DeleteServiceResponse) => any;
1061
397
  }
1062
- /**
1063
- * <p>No service exists with the specified ID.</p>
1064
- */
398
+
1065
399
  export interface ServiceNotFound extends __SmithyException, $MetadataBearer {
1066
400
  name: "ServiceNotFound";
1067
401
  $fault: "client";
1068
402
  Message?: string;
1069
403
  }
1070
404
  export declare namespace ServiceNotFound {
1071
- /**
1072
- * @internal
1073
- */
405
+
1074
406
  const filterSensitiveLog: (obj: ServiceNotFound) => any;
1075
407
  }
1076
408
  export interface DeregisterInstanceRequest {
1077
- /**
1078
- * <p>The ID of the service that the instance is associated with.</p>
1079
- */
409
+
1080
410
  ServiceId: string | undefined;
1081
- /**
1082
- * <p>The value that you specified for <code>Id</code> in the <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html">RegisterInstance</a> request.</p>
1083
- */
411
+
1084
412
  InstanceId: string | undefined;
1085
413
  }
1086
414
  export declare namespace DeregisterInstanceRequest {
1087
- /**
1088
- * @internal
1089
- */
415
+
1090
416
  const filterSensitiveLog: (obj: DeregisterInstanceRequest) => any;
1091
417
  }
1092
418
  export interface DeregisterInstanceResponse {
1093
- /**
1094
- * <p>A value that you can use to determine whether the request completed successfully.
1095
- * To get the status of the operation, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html">GetOperation</a>.</p>
1096
- */
419
+
1097
420
  OperationId?: string;
1098
421
  }
1099
422
  export declare namespace DeregisterInstanceResponse {
1100
- /**
1101
- * @internal
1102
- */
423
+
1103
424
  const filterSensitiveLog: (obj: DeregisterInstanceResponse) => any;
1104
425
  }
1105
- /**
1106
- * <p>No instance exists with the specified ID, or the instance was recently registered, and information about the
1107
- * instance hasn't propagated yet.</p>
1108
- */
426
+
1109
427
  export interface InstanceNotFound extends __SmithyException, $MetadataBearer {
1110
428
  name: "InstanceNotFound";
1111
429
  $fault: "client";
1112
430
  Message?: string;
1113
431
  }
1114
432
  export declare namespace InstanceNotFound {
1115
- /**
1116
- * @internal
1117
- */
433
+
1118
434
  const filterSensitiveLog: (obj: InstanceNotFound) => any;
1119
435
  }
1120
436
  export declare enum HealthStatusFilter {
@@ -1124,68 +440,25 @@ export declare enum HealthStatusFilter {
1124
440
  UNHEALTHY = "UNHEALTHY"
1125
441
  }
1126
442
  export interface DiscoverInstancesRequest {
1127
- /**
1128
- * <p>The <code>HttpName</code> name of the namespace. It's found in the <code>HttpProperties</code> member of the
1129
- * <code>Properties</code> member of the namespace.</p>
1130
- */
443
+
1131
444
  NamespaceName: string | undefined;
1132
- /**
1133
- * <p>The name of the service that you specified when you registered the instance.</p>
1134
- */
445
+
1135
446
  ServiceName: string | undefined;
1136
- /**
1137
- * <p>The maximum number of instances that you want Cloud Map to return in the response to a
1138
- * <code>DiscoverInstances</code> request. If you don't specify a value for <code>MaxResults</code>, Cloud Map returns up
1139
- * to 100 instances.</p>
1140
- */
447
+
1141
448
  MaxResults?: number;
1142
- /**
1143
- * <p>Filters to scope the results based on custom attributes for the instance (for example, <code>{version=v1,
1144
- * az=1a}</code>). Only instances that match all the specified key-value pairs are returned.</p>
1145
- */
449
+
1146
450
  QueryParameters?: {
1147
451
  [key: string]: string;
1148
452
  };
1149
- /**
1150
- * <p>Opportunistic filters to scope the results based on custom attributes. If there are instances that match both
1151
- * the filters specified in both the <code>QueryParameters</code> parameter and this parameter, all of these instances
1152
- * are returned. Otherwise, the filters are ignored, and only instances that match the filters that are specified in the
1153
- * <code>QueryParameters</code> parameter are returned.</p>
1154
- */
453
+
1155
454
  OptionalParameters?: {
1156
455
  [key: string]: string;
1157
456
  };
1158
- /**
1159
- * <p>The health status of the instances that you want to discover. This parameter is ignored for services that don't
1160
- * have a health check configured, and
1161
- * all
1162
- * instances are returned.</p>
1163
- * <dl>
1164
- * <dt>HEALTHY</dt>
1165
- * <dd>
1166
- * <p>Returns healthy instances.</p>
1167
- * </dd>
1168
- * <dt>UNHEALTHY</dt>
1169
- * <dd>
1170
- * <p>Returns unhealthy instances.</p>
1171
- * </dd>
1172
- * <dt>ALL</dt>
1173
- * <dd>
1174
- * <p>Returns all instances.</p>
1175
- * </dd>
1176
- * <dt>HEALTHY_OR_ELSE_ALL</dt>
1177
- * <dd>
1178
- * <p>Returns healthy instances, unless none are reporting a healthy state. In that case, return all instances.
1179
- * This is also called failing open.</p>
1180
- * </dd>
1181
- * </dl>
1182
- */
457
+
1183
458
  HealthStatus?: HealthStatusFilter | string;
1184
459
  }
1185
460
  export declare namespace DiscoverInstancesRequest {
1186
- /**
1187
- * @internal
1188
- */
461
+
1189
462
  const filterSensitiveLog: (obj: DiscoverInstancesRequest) => any;
1190
463
  }
1191
464
  export declare enum HealthStatus {
@@ -1193,109 +466,61 @@ export declare enum HealthStatus {
1193
466
  UNHEALTHY = "UNHEALTHY",
1194
467
  UNKNOWN = "UNKNOWN"
1195
468
  }
1196
- /**
1197
- * <p>In a response to a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a> request, <code>HttpInstanceSummary</code> contains information about one instance that
1198
- * matches the values that you specified in the request.</p>
1199
- */
469
+
1200
470
  export interface HttpInstanceSummary {
1201
- /**
1202
- * <p>The ID of an instance that matches the values that you specified in the request.</p>
1203
- */
471
+
1204
472
  InstanceId?: string;
1205
- /**
1206
- * <p>
1207
- * <code></code>
1208
- * <code></code>
1209
- * <code></code>
1210
- * </p>
1211
- * <p>The <code>HttpName</code> name of the namespace. It's found in the <code>HttpProperties</code> member of the
1212
- * <code>Properties</code> member of the namespace.</p>
1213
- */
473
+
1214
474
  NamespaceName?: string;
1215
- /**
1216
- * <p>The name of the service that you specified when you registered the instance.</p>
1217
- */
475
+
1218
476
  ServiceName?: string;
1219
- /**
1220
- * <p>If you configured health checking in the service, the current health status of the service instance.</p>
1221
- */
477
+
1222
478
  HealthStatus?: HealthStatus | string;
1223
- /**
1224
- * <p>If you included any attributes when you registered the instance, the values of those attributes.</p>
1225
- */
479
+
1226
480
  Attributes?: {
1227
481
  [key: string]: string;
1228
482
  };
1229
483
  }
1230
484
  export declare namespace HttpInstanceSummary {
1231
- /**
1232
- * @internal
1233
- */
485
+
1234
486
  const filterSensitiveLog: (obj: HttpInstanceSummary) => any;
1235
487
  }
1236
488
  export interface DiscoverInstancesResponse {
1237
- /**
1238
- * <p>A complex type that contains one <code>HttpInstanceSummary</code> for each registered instance.</p>
1239
- */
489
+
1240
490
  Instances?: HttpInstanceSummary[];
1241
491
  }
1242
492
  export declare namespace DiscoverInstancesResponse {
1243
- /**
1244
- * @internal
1245
- */
493
+
1246
494
  const filterSensitiveLog: (obj: DiscoverInstancesResponse) => any;
1247
495
  }
1248
- /**
1249
- * <p>The operation can't be completed because you've reached the quota for the number of requests. For more
1250
- * information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/throttling.html">Cloud Map API request throttling
1251
- * quota</a> in the <i>Cloud Map Developer Guide</i>.</p>
1252
- */
496
+
1253
497
  export interface RequestLimitExceeded extends __SmithyException, $MetadataBearer {
1254
498
  name: "RequestLimitExceeded";
1255
499
  $fault: "client";
1256
500
  Message?: string;
1257
501
  }
1258
502
  export declare namespace RequestLimitExceeded {
1259
- /**
1260
- * @internal
1261
- */
503
+
1262
504
  const filterSensitiveLog: (obj: RequestLimitExceeded) => any;
1263
505
  }
1264
- /**
1265
- * <p>A complex type that contains information about changes to the Route 53 DNS records that Cloud Map creates when you
1266
- * register an instance.</p>
1267
- */
506
+
1268
507
  export interface DnsConfigChange {
1269
- /**
1270
- * <p>An array that contains one <code>DnsRecord</code> object for each Route 53 record that you want Cloud Map to
1271
- * create when you register an instance.</p>
1272
- */
508
+
1273
509
  DnsRecords: DnsRecord[] | undefined;
1274
510
  }
1275
511
  export declare namespace DnsConfigChange {
1276
- /**
1277
- * @internal
1278
- */
512
+
1279
513
  const filterSensitiveLog: (obj: DnsConfigChange) => any;
1280
514
  }
1281
- /**
1282
- * <p>A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when you create a
1283
- * namespace.</p>
1284
- */
515
+
1285
516
  export interface DnsProperties {
1286
- /**
1287
- * <p>The ID for the Route 53 hosted zone that Cloud Map creates when you create a namespace.</p>
1288
- */
517
+
1289
518
  HostedZoneId?: string;
1290
- /**
1291
- * <p>Start of Authority (SOA) record for the hosted zone.</p>
1292
- */
519
+
1293
520
  SOA?: SOA;
1294
521
  }
1295
522
  export declare namespace DnsProperties {
1296
- /**
1297
- * @internal
1298
- */
523
+
1299
524
  const filterSensitiveLog: (obj: DnsProperties) => any;
1300
525
  }
1301
526
  export declare enum FilterCondition {
@@ -1304,271 +529,90 @@ export declare enum FilterCondition {
1304
529
  IN = "IN"
1305
530
  }
1306
531
  export interface GetInstanceRequest {
1307
- /**
1308
- * <p>The ID of the service that the instance is associated with.</p>
1309
- */
532
+
1310
533
  ServiceId: string | undefined;
1311
- /**
1312
- * <p>The ID of the instance that you want to get information about.</p>
1313
- */
534
+
1314
535
  InstanceId: string | undefined;
1315
536
  }
1316
537
  export declare namespace GetInstanceRequest {
1317
- /**
1318
- * @internal
1319
- */
538
+
1320
539
  const filterSensitiveLog: (obj: GetInstanceRequest) => any;
1321
540
  }
1322
- /**
1323
- * <p>A complex type that contains information about an instance that Cloud Map creates when you submit a
1324
- * <code>RegisterInstance</code> request.</p>
1325
- */
541
+
1326
542
  export interface Instance {
1327
- /**
1328
- * <p>An identifier that you want to associate with the instance. Note the following:</p>
1329
- * <ul>
1330
- * <li>
1331
- * <p>If the service that's specified by <code>ServiceId</code> includes settings for an <code>SRV</code> record,
1332
- * the value of <code>InstanceId</code> is automatically included as part of the value for the <code>SRV</code>
1333
- * record. For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type">DnsRecord > Type</a>.</p>
1334
- * </li>
1335
- * <li>
1336
- * <p>You can use this value to update an existing instance.</p>
1337
- * </li>
1338
- * <li>
1339
- * <p>To register a new instance, you must specify a value that's unique among instances that you register by using
1340
- * the same service. </p>
1341
- * </li>
1342
- * <li>
1343
- * <p>If you specify an existing <code>InstanceId</code> and <code>ServiceId</code>, Cloud Map updates the existing
1344
- * DNS records. If there's also an existing health check, Cloud Map deletes the old health check and creates a new
1345
- * one. </p>
1346
- * <note>
1347
- * <p>The health check isn't deleted immediately, so it will still appear for a while if you submit a
1348
- * <code>ListHealthChecks</code> request, for example.</p>
1349
- * </note>
1350
- * </li>
1351
- * </ul>
1352
- */
543
+
1353
544
  Id: string | undefined;
1354
- /**
1355
- * <p>A unique string that identifies the request and that allows failed <code>RegisterInstance</code> requests to be
1356
- * retried without the risk of executing the operation twice. You must use a unique <code>CreatorRequestId</code> string
1357
- * every time you submit a <code>RegisterInstance</code> request if you're registering additional instances for the same
1358
- * namespace and service. <code>CreatorRequestId</code> can be any unique string (for example, a date/time
1359
- * stamp).</p>
1360
- */
545
+
1361
546
  CreatorRequestId?: string;
1362
- /**
1363
- * <p>A string map that contains the following information for the service that you specify in
1364
- * <code>ServiceId</code>:</p>
1365
- * <ul>
1366
- * <li>
1367
- * <p>The attributes that apply to the records that are defined in the service. </p>
1368
- * </li>
1369
- * <li>
1370
- * <p>For each attribute, the applicable value.</p>
1371
- * </li>
1372
- * </ul>
1373
- * <p>Supported attribute keys include the following:</p>
1374
- * <dl>
1375
- * <dt>AWS_ALIAS_DNS_NAME</dt>
1376
- * <dd>
1377
- * <p>If you want Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify
1378
- * the DNS name that's associated with the load balancer. For information about how to get the DNS name, see <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-DNSName">AliasTarget->DNSName</a> in the <i>Route 53 API Reference</i>.</p>
1379
- * <p>Note the following:</p>
1380
- * <ul>
1381
- * <li>
1382
- * <p>The configuration for the service that's specified by <code>ServiceId</code> must include settings for an
1383
- * <code>A</code> record, an <code>AAAA</code> record, or both.</p>
1384
- * </li>
1385
- * <li>
1386
- * <p>In the service that's specified by <code>ServiceId</code>, the value of <code>RoutingPolicy</code> must be
1387
- * <code>WEIGHTED</code>.</p>
1388
- * </li>
1389
- * <li>
1390
- * <p>If the service that's specified by <code>ServiceId</code> includes <code>HealthCheckConfig</code> settings,
1391
- * Cloud Map creates the health check, but it won't associate the health check with the alias record.</p>
1392
- * </li>
1393
- * <li>
1394
- * <p>Auto naming currently doesn't support creating alias records that route traffic to Amazon Web Services resources other
1395
- * than ELB load balancers.</p>
1396
- * </li>
1397
- * <li>
1398
- * <p>If you specify a value for <code>AWS_ALIAS_DNS_NAME</code>, don't specify values for any of the
1399
- * <code>AWS_INSTANCE</code> attributes.</p>
1400
- * </li>
1401
- * </ul>
1402
- * </dd>
1403
- * <dt>AWS_EC2_INSTANCE_ID</dt>
1404
- * <dd>
1405
- * <p>
1406
- * <i>HTTP namespaces only.</i> The Amazon EC2 instance ID for the instance. The
1407
- * <code>AWS_INSTANCE_IPV4</code> attribute contains the primary private IPv4 address.</p>
1408
- * </dd>
1409
- * <dt>AWS_INIT_HEALTH_STATUS</dt>
1410
- * <dd>
1411
- * <p>If the service configuration includes <code>HealthCheckCustomConfig</code>, you can optionally use
1412
- * <code>AWS_INIT_HEALTH_STATUS</code> to specify the initial status of the custom health check,
1413
- * <code>HEALTHY</code> or <code>UNHEALTHY</code>. If you don't specify a value for
1414
- * <code>AWS_INIT_HEALTH_STATUS</code>, the initial status is <code>HEALTHY</code>.</p>
1415
- * </dd>
1416
- * <dt>AWS_INSTANCE_CNAME</dt>
1417
- * <dd>
1418
- * <p>If the service configuration includes a <code>CNAME</code> record, the domain name that you want Route 53 to
1419
- * return in response to DNS queries (for example, <code>example.com</code>).</p>
1420
- * <p>This value is required if the service specified by <code>ServiceId</code> includes settings for an
1421
- * <code>CNAME</code> record.</p>
1422
- * </dd>
1423
- * <dt>AWS_INSTANCE_IPV4</dt>
1424
- * <dd>
1425
- * <p>If the service configuration includes an <code>A</code> record, the IPv4 address that you want Route 53 to
1426
- * return in response to DNS queries (for example, <code>192.0.2.44</code>).</p>
1427
- * <p>This value is required if the service specified by <code>ServiceId</code> includes settings for an
1428
- * <code>A</code> record. If the service includes settings for an <code>SRV</code> record, you must specify a value
1429
- * for <code>AWS_INSTANCE_IPV4</code>, <code>AWS_INSTANCE_IPV6</code>, or both.</p>
1430
- * </dd>
1431
- * <dt>AWS_INSTANCE_IPV6</dt>
1432
- * <dd>
1433
- * <p>If the service configuration includes an <code>AAAA</code> record, the IPv6 address that you want Route 53 to
1434
- * return in response to DNS queries (for example, <code>2001:0db8:85a3:0000:0000:abcd:0001:2345</code>).</p>
1435
- * <p>This value is required if the service specified by <code>ServiceId</code> includes settings for an
1436
- * <code>AAAA</code> record. If the service includes settings for an <code>SRV</code> record, you must specify a
1437
- * value for <code>AWS_INSTANCE_IPV4</code>, <code>AWS_INSTANCE_IPV6</code>, or both.</p>
1438
- * </dd>
1439
- * <dt>AWS_INSTANCE_PORT</dt>
1440
- * <dd>
1441
- * <p>If the service includes an <code>SRV</code> record, the value that you want Route 53 to return for the
1442
- * port.</p>
1443
- * <p>If the service includes <code>HealthCheckConfig</code>, the port on the endpoint that you want Route 53 to send
1444
- * requests to. </p>
1445
- * <p>This value is required if you specified settings for an <code>SRV</code> record or a Route 53 health check when
1446
- * you created the service.</p>
1447
- * </dd>
1448
- * </dl>
1449
- */
547
+
1450
548
  Attributes?: {
1451
549
  [key: string]: string;
1452
550
  };
1453
551
  }
1454
552
  export declare namespace Instance {
1455
- /**
1456
- * @internal
1457
- */
553
+
1458
554
  const filterSensitiveLog: (obj: Instance) => any;
1459
555
  }
1460
556
  export interface GetInstanceResponse {
1461
- /**
1462
- * <p>A complex type that contains information about a specified instance.</p>
1463
- */
557
+
1464
558
  Instance?: Instance;
1465
559
  }
1466
560
  export declare namespace GetInstanceResponse {
1467
- /**
1468
- * @internal
1469
- */
561
+
1470
562
  const filterSensitiveLog: (obj: GetInstanceResponse) => any;
1471
563
  }
1472
564
  export interface GetInstancesHealthStatusRequest {
1473
- /**
1474
- * <p>The ID of the service that the instance is associated with.</p>
1475
- */
565
+
1476
566
  ServiceId: string | undefined;
1477
- /**
1478
- * <p>An array that contains the IDs of all the instances that you want to get the health status for.</p>
1479
- * <p>If you omit <code>Instances</code>, Cloud Map returns the health status for all the instances that are
1480
- * associated with the specified service.</p>
1481
- * <note>
1482
- * <p>To get the IDs for the instances that you've registered by using a specified service, submit a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_ListInstances.html">ListInstances</a> request.</p>
1483
- * </note>
1484
- */
567
+
1485
568
  Instances?: string[];
1486
- /**
1487
- * <p>The maximum number of instances that you want Cloud Map to return in the response to a
1488
- * <code>GetInstancesHealthStatus</code> request. If you don't specify a value for <code>MaxResults</code>, Cloud Map
1489
- * returns up to 100 instances.</p>
1490
- */
569
+
1491
570
  MaxResults?: number;
1492
- /**
1493
- * <p>For the first <code>GetInstancesHealthStatus</code> request, omit this value.</p>
1494
- * <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit another
1495
- * <code>GetInstancesHealthStatus</code> request to get the next group of results. Specify the value of
1496
- * <code>NextToken</code> from the previous response in the next request.</p>
1497
- */
571
+
1498
572
  NextToken?: string;
1499
573
  }
1500
574
  export declare namespace GetInstancesHealthStatusRequest {
1501
- /**
1502
- * @internal
1503
- */
575
+
1504
576
  const filterSensitiveLog: (obj: GetInstancesHealthStatusRequest) => any;
1505
577
  }
1506
578
  export interface GetInstancesHealthStatusResponse {
1507
- /**
1508
- * <p>A complex type that contains the IDs and the health status of the instances that you specified in the
1509
- * <code>GetInstancesHealthStatus</code> request.</p>
1510
- */
579
+
1511
580
  Status?: {
1512
581
  [key: string]: HealthStatus | string;
1513
582
  };
1514
- /**
1515
- * <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit another
1516
- * <code>GetInstancesHealthStatus</code> request to get the next group of results. Specify the value of
1517
- * <code>NextToken</code> from the previous response in the next request.</p>
1518
- */
583
+
1519
584
  NextToken?: string;
1520
585
  }
1521
586
  export declare namespace GetInstancesHealthStatusResponse {
1522
- /**
1523
- * @internal
1524
- */
587
+
1525
588
  const filterSensitiveLog: (obj: GetInstancesHealthStatusResponse) => any;
1526
589
  }
1527
590
  export interface GetNamespaceRequest {
1528
- /**
1529
- * <p>The ID of the namespace that you want to get information about.</p>
1530
- */
591
+
1531
592
  Id: string | undefined;
1532
593
  }
1533
594
  export declare namespace GetNamespaceRequest {
1534
- /**
1535
- * @internal
1536
- */
595
+
1537
596
  const filterSensitiveLog: (obj: GetNamespaceRequest) => any;
1538
597
  }
1539
- /**
1540
- * <p>A complex type that contains the name of an HTTP namespace.</p>
1541
- */
598
+
1542
599
  export interface HttpProperties {
1543
- /**
1544
- * <p>The name of an HTTP namespace.</p>
1545
- */
600
+
1546
601
  HttpName?: string;
1547
602
  }
1548
603
  export declare namespace HttpProperties {
1549
- /**
1550
- * @internal
1551
- */
604
+
1552
605
  const filterSensitiveLog: (obj: HttpProperties) => any;
1553
606
  }
1554
- /**
1555
- * <p>A complex type that contains information that's specific to the namespace type.</p>
1556
- */
607
+
1557
608
  export interface NamespaceProperties {
1558
- /**
1559
- * <p>A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when you create a
1560
- * namespace.</p>
1561
- */
609
+
1562
610
  DnsProperties?: DnsProperties;
1563
- /**
1564
- * <p>A complex type that contains the name of an HTTP namespace.</p>
1565
- */
611
+
1566
612
  HttpProperties?: HttpProperties;
1567
613
  }
1568
614
  export declare namespace NamespaceProperties {
1569
- /**
1570
- * @internal
1571
- */
615
+
1572
616
  const filterSensitiveLog: (obj: NamespaceProperties) => any;
1573
617
  }
1574
618
  export declare enum NamespaceType {
@@ -1576,94 +620,45 @@ export declare enum NamespaceType {
1576
620
  DNS_PUBLIC = "DNS_PUBLIC",
1577
621
  HTTP = "HTTP"
1578
622
  }
1579
- /**
1580
- * <p>A complex type that contains information about a specified namespace.</p>
1581
- */
623
+
1582
624
  export interface Namespace {
1583
- /**
1584
- * <p>The ID of a namespace.</p>
1585
- */
625
+
1586
626
  Id?: string;
1587
- /**
1588
- * <p>The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.</p>
1589
- */
627
+
1590
628
  Arn?: string;
1591
- /**
1592
- * <p>The name of the namespace, such as <code>example.com</code>.</p>
1593
- */
629
+
1594
630
  Name?: string;
1595
- /**
1596
- * <p>The type of the namespace. The methods for discovering instances depends on the value that you specify:</p>
1597
- * <dl>
1598
- * <dt>HTTP</dt>
1599
- * <dd>
1600
- * <p>Instances can be discovered only programmatically, using the Cloud Map <code>DiscoverInstances</code>
1601
- * API.</p>
1602
- * </dd>
1603
- * <dt>DNS_PUBLIC</dt>
1604
- * <dd>
1605
- * <p>Instances can be discovered using public DNS queries and using the <code>DiscoverInstances</code> API.</p>
1606
- * </dd>
1607
- * <dt>DNS_PRIVATE</dt>
1608
- * <dd>
1609
- * <p>Instances can be discovered using DNS queries in VPCs and using the <code>DiscoverInstances</code>
1610
- * API.</p>
1611
- * </dd>
1612
- * </dl>
1613
- */
631
+
1614
632
  Type?: NamespaceType | string;
1615
- /**
1616
- * <p>The description that you specify for the namespace when you create it.</p>
1617
- */
633
+
1618
634
  Description?: string;
1619
- /**
1620
- * <p>The number of services that are associated with the namespace.</p>
1621
- */
635
+
1622
636
  ServiceCount?: number;
1623
- /**
1624
- * <p>A complex type that contains information that's specific to the type of the namespace.</p>
1625
- */
637
+
1626
638
  Properties?: NamespaceProperties;
1627
- /**
1628
- * <p>The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The
1629
- * value of <code>CreateDate</code> is accurate to milliseconds. For example, the value <code>1516925490.087</code>
1630
- * represents Friday, January 26, 2018 12:11:30.087 AM.</p>
1631
- */
639
+
1632
640
  CreateDate?: Date;
1633
- /**
1634
- * <p>A unique string that identifies the request and that allows failed requests to be retried without the risk of
1635
- * running an operation twice. </p>
1636
- */
641
+
1637
642
  CreatorRequestId?: string;
1638
643
  }
1639
644
  export declare namespace Namespace {
1640
- /**
1641
- * @internal
1642
- */
645
+
1643
646
  const filterSensitiveLog: (obj: Namespace) => any;
1644
647
  }
1645
648
  export interface GetNamespaceResponse {
1646
- /**
1647
- * <p>A complex type that contains information about the specified namespace.</p>
1648
- */
649
+
1649
650
  Namespace?: Namespace;
1650
651
  }
1651
652
  export declare namespace GetNamespaceResponse {
1652
- /**
1653
- * @internal
1654
- */
653
+
1655
654
  const filterSensitiveLog: (obj: GetNamespaceResponse) => any;
1656
655
  }
1657
656
  export interface GetOperationRequest {
1658
- /**
1659
- * <p>The ID of the operation that you want to get more information about.</p>
1660
- */
657
+
1661
658
  OperationId: string | undefined;
1662
659
  }
1663
660
  export declare namespace GetOperationRequest {
1664
- /**
1665
- * @internal
1666
- */
661
+
1667
662
  const filterSensitiveLog: (obj: GetOperationRequest) => any;
1668
663
  }
1669
664
  export declare enum OperationStatus {
@@ -1685,450 +680,168 @@ export declare enum OperationType {
1685
680
  UPDATE_NAMESPACE = "UPDATE_NAMESPACE",
1686
681
  UPDATE_SERVICE = "UPDATE_SERVICE"
1687
682
  }
1688
- /**
1689
- * <p>A complex type that contains information about a specified operation.</p>
1690
- */
683
+
1691
684
  export interface Operation {
1692
- /**
1693
- * <p>The ID of the operation that you want to get information about.</p>
1694
- */
685
+
1695
686
  Id?: string;
1696
- /**
1697
- * <p>The name of the operation that's associated with the specified ID.</p>
1698
- */
687
+
1699
688
  Type?: OperationType | string;
1700
- /**
1701
- * <p>The status of the operation. Values include the following:</p>
1702
- * <dl>
1703
- * <dt>SUBMITTED</dt>
1704
- * <dd>
1705
- * <p>This is the initial state that occurs immediately after you submit a request.</p>
1706
- * </dd>
1707
- * <dt>PENDING</dt>
1708
- * <dd>
1709
- * <p>Cloud Map is performing the operation.</p>
1710
- * </dd>
1711
- * <dt>SUCCESS</dt>
1712
- * <dd>
1713
- * <p>The operation succeeded.</p>
1714
- * </dd>
1715
- * <dt>FAIL</dt>
1716
- * <dd>
1717
- * <p>The operation failed. For the failure reason, see <code>ErrorMessage</code>.</p>
1718
- * </dd>
1719
- * </dl>
1720
- */
689
+
1721
690
  Status?: OperationStatus | string;
1722
- /**
1723
- * <p>If the value of <code>Status</code> is <code>FAIL</code>, the reason that the operation failed.</p>
1724
- */
691
+
1725
692
  ErrorMessage?: string;
1726
- /**
1727
- * <p>The code associated with <code>ErrorMessage</code>. Values for <code>ErrorCode</code> include the
1728
- * following:</p>
1729
- * <ul>
1730
- * <li>
1731
- * <p>
1732
- * <code>ACCESS_DENIED</code>
1733
- * </p>
1734
- * </li>
1735
- * <li>
1736
- * <p>
1737
- * <code>CANNOT_CREATE_HOSTED_ZONE</code>
1738
- * </p>
1739
- * </li>
1740
- * <li>
1741
- * <p>
1742
- * <code>EXPIRED_TOKEN</code>
1743
- * </p>
1744
- * </li>
1745
- * <li>
1746
- * <p>
1747
- * <code>HOSTED_ZONE_NOT_FOUND</code>
1748
- * </p>
1749
- * </li>
1750
- * <li>
1751
- * <p>
1752
- * <code>INTERNAL_FAILURE</code>
1753
- * </p>
1754
- * </li>
1755
- * <li>
1756
- * <p>
1757
- * <code>INVALID_CHANGE_BATCH</code>
1758
- * </p>
1759
- * </li>
1760
- * <li>
1761
- * <p>
1762
- * <code>THROTTLED_REQUEST</code>
1763
- * </p>
1764
- * </li>
1765
- * </ul>
1766
- */
693
+
1767
694
  ErrorCode?: string;
1768
- /**
1769
- * <p>The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time (UTC).
1770
- * The value of <code>CreateDate</code> is accurate to milliseconds. For example, the value <code>1516925490.087</code>
1771
- * represents Friday, January 26, 2018 12:11:30.087 AM.</p>
1772
- */
695
+
1773
696
  CreateDate?: Date;
1774
- /**
1775
- * <p>The date and time that the value of <code>Status</code> changed to the current value, in Unix date/time format
1776
- * and Coordinated Universal Time (UTC). The value of <code>UpdateDate</code> is accurate to milliseconds. For example,
1777
- * the value <code>1516925490.087</code> represents Friday, January 26, 2018 12:11:30.087 AM.</p>
1778
- */
697
+
1779
698
  UpdateDate?: Date;
1780
- /**
1781
- * <p>The name of the target entity that's associated with the operation:</p>
1782
- * <dl>
1783
- * <dt>NAMESPACE</dt>
1784
- * <dd>
1785
- * <p>The namespace ID is returned in the <code>ResourceId</code> property.</p>
1786
- * </dd>
1787
- * <dt>SERVICE</dt>
1788
- * <dd>
1789
- * <p>The service ID is returned in the <code>ResourceId</code> property.</p>
1790
- * </dd>
1791
- * <dt>INSTANCE</dt>
1792
- * <dd>
1793
- * <p>The instance ID is returned in the <code>ResourceId</code> property.</p>
1794
- * </dd>
1795
- * </dl>
1796
- */
699
+
1797
700
  Targets?: {
1798
701
  [key: string]: string;
1799
702
  };
1800
703
  }
1801
704
  export declare namespace Operation {
1802
- /**
1803
- * @internal
1804
- */
705
+
1805
706
  const filterSensitiveLog: (obj: Operation) => any;
1806
707
  }
1807
708
  export interface GetOperationResponse {
1808
- /**
1809
- * <p>A complex type that contains information about the operation.</p>
1810
- */
709
+
1811
710
  Operation?: Operation;
1812
711
  }
1813
712
  export declare namespace GetOperationResponse {
1814
- /**
1815
- * @internal
1816
- */
713
+
1817
714
  const filterSensitiveLog: (obj: GetOperationResponse) => any;
1818
715
  }
1819
- /**
1820
- * <p>No operation exists with the specified ID.</p>
1821
- */
716
+
1822
717
  export interface OperationNotFound extends __SmithyException, $MetadataBearer {
1823
718
  name: "OperationNotFound";
1824
719
  $fault: "client";
1825
720
  Message?: string;
1826
721
  }
1827
722
  export declare namespace OperationNotFound {
1828
- /**
1829
- * @internal
1830
- */
723
+
1831
724
  const filterSensitiveLog: (obj: OperationNotFound) => any;
1832
725
  }
1833
726
  export interface GetServiceRequest {
1834
- /**
1835
- * <p>The ID of the service that you want to get settings for.</p>
1836
- */
727
+
1837
728
  Id: string | undefined;
1838
729
  }
1839
730
  export declare namespace GetServiceRequest {
1840
- /**
1841
- * @internal
1842
- */
731
+
1843
732
  const filterSensitiveLog: (obj: GetServiceRequest) => any;
1844
733
  }
1845
734
  export interface GetServiceResponse {
1846
- /**
1847
- * <p>A complex type that contains information about the service.</p>
1848
- */
735
+
1849
736
  Service?: Service;
1850
737
  }
1851
738
  export declare namespace GetServiceResponse {
1852
- /**
1853
- * @internal
1854
- */
739
+
1855
740
  const filterSensitiveLog: (obj: GetServiceResponse) => any;
1856
741
  }
1857
- /**
1858
- * <p>Updated properties for the HTTP
1859
- * namespace.</p>
1860
- */
742
+
1861
743
  export interface HttpNamespaceChange {
1862
- /**
1863
- * <p>An updated description for the HTTP
1864
- * namespace.</p>
1865
- */
744
+
1866
745
  Description: string | undefined;
1867
746
  }
1868
747
  export declare namespace HttpNamespaceChange {
1869
- /**
1870
- * @internal
1871
- */
748
+
1872
749
  const filterSensitiveLog: (obj: HttpNamespaceChange) => any;
1873
750
  }
1874
- /**
1875
- * <p>A complex type that contains information about the instances that you registered by using a specified
1876
- * service.</p>
1877
- */
751
+
1878
752
  export interface InstanceSummary {
1879
- /**
1880
- * <p>The ID for an instance that you created by using a specified service.</p>
1881
- */
753
+
1882
754
  Id?: string;
1883
- /**
1884
- * <p>A string map that contains the following information:</p>
1885
- * <ul>
1886
- * <li>
1887
- * <p>The attributes that are associated with the instance. </p>
1888
- * </li>
1889
- * <li>
1890
- * <p>For each attribute, the applicable value.</p>
1891
- * </li>
1892
- * </ul>
1893
- * <p>Supported attribute keys include the following:</p>
1894
- * <dl>
1895
- * <dt>AWS_ALIAS_DNS_NAME</dt>
1896
- * <dd>
1897
- * <p>For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's associated with the
1898
- * load balancer. </p>
1899
- * </dd>
1900
- * <dt>AWS_EC2_INSTANCE_ID (HTTP namespaces only)</dt>
1901
- * <dd>
1902
- * <p>The Amazon EC2 instance ID for the instance. When the <code>AWS_EC2_INSTANCE_ID</code> attribute is specified,
1903
- * then the <code>AWS_INSTANCE_IPV4</code> attribute contains the primary private IPv4 address.</p>
1904
- * </dd>
1905
- * <dt>AWS_INIT_HEALTH_STATUS</dt>
1906
- * <dd>
1907
- * <p>If the service configuration includes <code>HealthCheckCustomConfig</code>, you can optionally use
1908
- * <code>AWS_INIT_HEALTH_STATUS</code> to specify the initial status of the custom health check,
1909
- * <code>HEALTHY</code> or <code>UNHEALTHY</code>. If you don't specify a value for
1910
- * <code>AWS_INIT_HEALTH_STATUS</code>, the initial status is <code>HEALTHY</code>.</p>
1911
- * </dd>
1912
- * <dt>AWS_INSTANCE_CNAME</dt>
1913
- * <dd>
1914
- * <p>For a <code>CNAME</code> record, the domain name that Route 53 returns in response to DNS queries (for example,
1915
- * <code>example.com</code>).</p>
1916
- * </dd>
1917
- * <dt>AWS_INSTANCE_IPV4</dt>
1918
- * <dd>
1919
- * <p>For an <code>A</code> record, the IPv4 address that Route 53 returns in response to DNS queries (for example,
1920
- * <code>192.0.2.44</code>).</p>
1921
- * </dd>
1922
- * <dt>AWS_INSTANCE_IPV6</dt>
1923
- * <dd>
1924
- * <p>For an <code>AAAA</code> record, the IPv6 address that Route 53 returns in response to DNS queries (for example,
1925
- * <code>2001:0db8:85a3:0000:0000:abcd:0001:2345</code>).</p>
1926
- * </dd>
1927
- * <dt>AWS_INSTANCE_PORT</dt>
1928
- * <dd>
1929
- * <p>For an <code>SRV</code> record, the value that Route 53 returns for the port. In addition, if the service
1930
- * includes <code>HealthCheckConfig</code>, the port on the endpoint that Route 53 sends requests to.</p>
1931
- * </dd>
1932
- * </dl>
1933
- */
755
+
1934
756
  Attributes?: {
1935
757
  [key: string]: string;
1936
758
  };
1937
759
  }
1938
760
  export declare namespace InstanceSummary {
1939
- /**
1940
- * @internal
1941
- */
761
+
1942
762
  const filterSensitiveLog: (obj: InstanceSummary) => any;
1943
763
  }
1944
764
  export interface ListInstancesRequest {
1945
- /**
1946
- * <p>The ID of the service that you want to list instances for.</p>
1947
- */
765
+
1948
766
  ServiceId: string | undefined;
1949
- /**
1950
- * <p>For the first <code>ListInstances</code> request, omit this value.</p>
1951
- * <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit another
1952
- * <code>ListInstances</code> request to get the next group of results. Specify the value of <code>NextToken</code>
1953
- * from the previous response in the next request.</p>
1954
- */
767
+
1955
768
  NextToken?: string;
1956
- /**
1957
- * <p>The maximum number of instances that you want Cloud Map to return in the response to a
1958
- * <code>ListInstances</code> request. If you don't specify a value for <code>MaxResults</code>, Cloud Map returns up
1959
- * to 100 instances.</p>
1960
- */
769
+
1961
770
  MaxResults?: number;
1962
771
  }
1963
772
  export declare namespace ListInstancesRequest {
1964
- /**
1965
- * @internal
1966
- */
773
+
1967
774
  const filterSensitiveLog: (obj: ListInstancesRequest) => any;
1968
775
  }
1969
776
  export interface ListInstancesResponse {
1970
- /**
1971
- * <p>Summary information about the instances that are associated with the specified service.</p>
1972
- */
777
+
1973
778
  Instances?: InstanceSummary[];
1974
- /**
1975
- * <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit another
1976
- * <code>ListInstances</code> request to get the next group of results. Specify the value of <code>NextToken</code>
1977
- * from the previous response in the next request.</p>
1978
- */
779
+
1979
780
  NextToken?: string;
1980
781
  }
1981
782
  export declare namespace ListInstancesResponse {
1982
- /**
1983
- * @internal
1984
- */
783
+
1985
784
  const filterSensitiveLog: (obj: ListInstancesResponse) => any;
1986
785
  }
1987
786
  export declare enum NamespaceFilterName {
1988
787
  TYPE = "TYPE"
1989
788
  }
1990
- /**
1991
- * <p>A complex type that identifies the namespaces that you want to list. You can choose to list public or private
1992
- * namespaces.</p>
1993
- */
789
+
1994
790
  export interface NamespaceFilter {
1995
- /**
1996
- * <p>Specify <code>TYPE</code>.</p>
1997
- */
791
+
1998
792
  Name: NamespaceFilterName | string | undefined;
1999
- /**
2000
- * <p>If you specify <code>EQ</code> for <code>Condition</code>, specify either <code>DNS_PUBLIC</code> or
2001
- * <code>DNS_PRIVATE</code>.</p>
2002
- * <p>If you specify <code>IN</code> for <code>Condition</code>, you can specify <code>DNS_PUBLIC</code>,
2003
- * <code>DNS_PRIVATE</code>, or both.</p>
2004
- */
793
+
2005
794
  Values: string[] | undefined;
2006
- /**
2007
- * <p>The operator that you want to use to determine whether <code>ListNamespaces</code> returns a namespace. Valid
2008
- * values for <code>condition</code> include:</p>
2009
- * <dl>
2010
- * <dt>EQ</dt>
2011
- * <dd>
2012
- * <p>When you specify <code>EQ</code> for the condition, you can choose to list only public namespaces or private
2013
- * namespaces, but not both. <code>EQ</code> is the default condition and can be omitted.</p>
2014
- * </dd>
2015
- * <dt>IN</dt>
2016
- * <dd>
2017
- * <p>When you specify <code>IN</code> for the condition, you can choose to list public namespaces, private
2018
- * namespaces, or both. </p>
2019
- * </dd>
2020
- * <dt>BETWEEN</dt>
2021
- * <dd>
2022
- * <p> Not applicable</p>
2023
- * </dd>
2024
- * </dl>
2025
- */
795
+
2026
796
  Condition?: FilterCondition | string;
2027
797
  }
2028
798
  export declare namespace NamespaceFilter {
2029
- /**
2030
- * @internal
2031
- */
799
+
2032
800
  const filterSensitiveLog: (obj: NamespaceFilter) => any;
2033
801
  }
2034
802
  export interface ListNamespacesRequest {
2035
- /**
2036
- * <p>For the first <code>ListNamespaces</code> request, omit this value.</p>
2037
- * <p>If the response contains <code>NextToken</code>, submit another <code>ListNamespaces</code> request to get the
2038
- * next group of results. Specify the value of <code>NextToken</code> from the previous response in the next
2039
- * request.</p>
2040
- * <note>
2041
- * <p>Cloud Map gets <code>MaxResults</code> namespaces and then filters them based on the specified criteria. It's
2042
- * possible that no namespaces in the first <code>MaxResults</code> namespaces matched the specified criteria but that
2043
- * subsequent groups of <code>MaxResults</code> namespaces do contain namespaces that match the criteria.</p>
2044
- * </note>
2045
- */
803
+
2046
804
  NextToken?: string;
2047
- /**
2048
- * <p>The maximum number of namespaces that you want Cloud Map to return in the response to a
2049
- * <code>ListNamespaces</code> request. If you don't specify a value for <code>MaxResults</code>, Cloud Map returns up
2050
- * to 100 namespaces.</p>
2051
- */
805
+
2052
806
  MaxResults?: number;
2053
- /**
2054
- * <p>A complex type that contains specifications for the namespaces that you want to list.</p>
2055
- * <p>If you specify more than one filter, a namespace must match all filters to be returned by
2056
- * <code>ListNamespaces</code>.</p>
2057
- */
807
+
2058
808
  Filters?: NamespaceFilter[];
2059
809
  }
2060
810
  export declare namespace ListNamespacesRequest {
2061
- /**
2062
- * @internal
2063
- */
811
+
2064
812
  const filterSensitiveLog: (obj: ListNamespacesRequest) => any;
2065
813
  }
2066
- /**
2067
- * <p>A complex type that contains information about a namespace.</p>
2068
- */
814
+
2069
815
  export interface NamespaceSummary {
2070
- /**
2071
- * <p>The ID of the namespace.</p>
2072
- */
816
+
2073
817
  Id?: string;
2074
- /**
2075
- * <p>The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.</p>
2076
- */
818
+
2077
819
  Arn?: string;
2078
- /**
2079
- * <p>The name of the namespace. When you create a namespace, Cloud Map automatically creates a Route 53 hosted zone
2080
- * that has the same name as the namespace.</p>
2081
- */
820
+
2082
821
  Name?: string;
2083
- /**
2084
- * <p>The type of the namespace, either public or private.</p>
2085
- */
822
+
2086
823
  Type?: NamespaceType | string;
2087
- /**
2088
- * <p>A description for the namespace.</p>
2089
- */
824
+
2090
825
  Description?: string;
2091
- /**
2092
- * <p>The number of services that were created using the namespace.</p>
2093
- */
826
+
2094
827
  ServiceCount?: number;
2095
- /**
2096
- * <p>The properties of the namespace.</p>
2097
- */
828
+
2098
829
  Properties?: NamespaceProperties;
2099
- /**
2100
- * <p>The date and time that the namespace was created.</p>
2101
- */
830
+
2102
831
  CreateDate?: Date;
2103
832
  }
2104
833
  export declare namespace NamespaceSummary {
2105
- /**
2106
- * @internal
2107
- */
834
+
2108
835
  const filterSensitiveLog: (obj: NamespaceSummary) => any;
2109
836
  }
2110
837
  export interface ListNamespacesResponse {
2111
- /**
2112
- * <p>An array that contains one <code>NamespaceSummary</code> object for each namespace that matches the specified
2113
- * filter criteria.</p>
2114
- */
838
+
2115
839
  Namespaces?: NamespaceSummary[];
2116
- /**
2117
- * <p>If the response contains <code>NextToken</code>, submit another <code>ListNamespaces</code> request to get the
2118
- * next group of results. Specify the value of <code>NextToken</code> from the previous response in the next
2119
- * request.</p>
2120
- * <note>
2121
- * <p>Cloud Map gets <code>MaxResults</code> namespaces and then filters them based on the specified criteria. It's
2122
- * possible that no namespaces in the first <code>MaxResults</code> namespaces matched the specified criteria but that
2123
- * subsequent groups of <code>MaxResults</code> namespaces do contain namespaces that match the criteria.</p>
2124
- * </note>
2125
- */
840
+
2126
841
  NextToken?: string;
2127
842
  }
2128
843
  export declare namespace ListNamespacesResponse {
2129
- /**
2130
- * @internal
2131
- */
844
+
2132
845
  const filterSensitiveLog: (obj: ListNamespacesResponse) => any;
2133
846
  }
2134
847
  export declare enum OperationFilterName {
@@ -2138,945 +851,366 @@ export declare enum OperationFilterName {
2138
851
  TYPE = "TYPE",
2139
852
  UPDATE_DATE = "UPDATE_DATE"
2140
853
  }
2141
- /**
2142
- * <p>A complex type that lets you select the operations that you want to list.</p>
2143
- */
854
+
2144
855
  export interface OperationFilter {
2145
- /**
2146
- * <p>Specify the operations that you want to get:</p>
2147
- * <ul>
2148
- * <li>
2149
- * <p>
2150
- * <b>NAMESPACE_ID</b>: Gets operations related to specified namespaces.</p>
2151
- * </li>
2152
- * <li>
2153
- * <p>
2154
- * <b>SERVICE_ID</b>: Gets operations related to specified services.</p>
2155
- * </li>
2156
- * <li>
2157
- * <p>
2158
- * <b>STATUS</b>: Gets operations based on the status of the operations:
2159
- * <code>SUBMITTED</code>, <code>PENDING</code>, <code>SUCCEED</code>, or <code>FAIL</code>.</p>
2160
- * </li>
2161
- * <li>
2162
- * <p>
2163
- * <b>TYPE</b>: Gets specified types of operation.</p>
2164
- * </li>
2165
- * <li>
2166
- * <p>
2167
- * <b>UPDATE_DATE</b>: Gets operations that changed status during a specified date/time
2168
- * range. </p>
2169
- * </li>
2170
- * </ul>
2171
- */
856
+
2172
857
  Name: OperationFilterName | string | undefined;
2173
- /**
2174
- * <p>Specify values that are applicable to the value that you specify for <code>Name</code>: </p>
2175
- * <ul>
2176
- * <li>
2177
- * <p>
2178
- * <b>NAMESPACE_ID</b>: Specify one namespace ID.</p>
2179
- * </li>
2180
- * <li>
2181
- * <p>
2182
- * <b>SERVICE_ID</b>: Specify one service ID.</p>
2183
- * </li>
2184
- * <li>
2185
- * <p>
2186
- * <b>STATUS</b>: Specify one or more statuses: <code>SUBMITTED</code>,
2187
- * <code>PENDING</code>, <code>SUCCEED</code>, or <code>FAIL</code>.</p>
2188
- * </li>
2189
- * <li>
2190
- * <p>
2191
- * <b>TYPE</b>: Specify one or more of the following types:
2192
- * <code>CREATE_NAMESPACE</code>, <code>DELETE_NAMESPACE</code>, <code>UPDATE_SERVICE</code>,
2193
- * <code>REGISTER_INSTANCE</code>, or <code>DEREGISTER_INSTANCE</code>.</p>
2194
- * </li>
2195
- * <li>
2196
- * <p>
2197
- * <b>UPDATE_DATE</b>: Specify a start date and an end date in Unix date/time format
2198
- * and Coordinated Universal Time (UTC). The start date must be the first value.</p>
2199
- * </li>
2200
- * </ul>
2201
- */
858
+
2202
859
  Values: string[] | undefined;
2203
- /**
2204
- * <p>The operator that you want to use to determine whether an operation matches the specified value. Valid values
2205
- * for condition include:</p>
2206
- * <ul>
2207
- * <li>
2208
- * <p>
2209
- * <code>EQ</code>: When you specify <code>EQ</code> for the condition, you can specify only one value.
2210
- * <code>EQ</code> is supported for <code>NAMESPACE_ID</code>, <code>SERVICE_ID</code>, <code>STATUS</code>, and
2211
- * <code>TYPE</code>. <code>EQ</code> is the default condition and can be omitted.</p>
2212
- * </li>
2213
- * <li>
2214
- * <p>
2215
- * <code>IN</code>: When you specify <code>IN</code> for the condition, you can specify a list of one or more
2216
- * values. <code>IN</code> is supported for <code>STATUS</code> and <code>TYPE</code>. An operation must match one of
2217
- * the specified values to be returned in the response.</p>
2218
- * </li>
2219
- * <li>
2220
- * <p>
2221
- * <code>BETWEEN</code>: Specify a start date and an end date in Unix date/time format and Coordinated Universal
2222
- * Time (UTC). The start date must be the first value. <code>BETWEEN</code> is supported for <code>UPDATE_DATE</code>.
2223
- * </p>
2224
- * </li>
2225
- * </ul>
2226
- */
860
+
2227
861
  Condition?: FilterCondition | string;
2228
862
  }
2229
863
  export declare namespace OperationFilter {
2230
- /**
2231
- * @internal
2232
- */
864
+
2233
865
  const filterSensitiveLog: (obj: OperationFilter) => any;
2234
866
  }
2235
867
  export interface ListOperationsRequest {
2236
- /**
2237
- * <p>For the first <code>ListOperations</code> request, omit this value.</p>
2238
- * <p>If the response contains <code>NextToken</code>, submit another <code>ListOperations</code> request to get the
2239
- * next group of results. Specify the value of <code>NextToken</code> from the previous response in the next
2240
- * request.</p>
2241
- * <note>
2242
- * <p>Cloud Map gets <code>MaxResults</code> operations and then filters them based on the specified criteria. It's
2243
- * possible that no operations in the first <code>MaxResults</code> operations matched the specified criteria but that
2244
- * subsequent groups of <code>MaxResults</code> operations do contain operations that match the criteria.</p>
2245
- * </note>
2246
- */
868
+
2247
869
  NextToken?: string;
2248
- /**
2249
- * <p>The maximum number of items that you want Cloud Map to return in the response to a <code>ListOperations</code>
2250
- * request. If you don't specify a value for <code>MaxResults</code>, Cloud Map returns up to 100 operations.</p>
2251
- */
870
+
2252
871
  MaxResults?: number;
2253
- /**
2254
- * <p>A complex type that contains specifications for the operations that you want to list, for example, operations
2255
- * that you started between a specified start date and end date.</p>
2256
- * <p>If you specify more than one filter, an operation must match all filters to be returned by
2257
- * <code>ListOperations</code>.</p>
2258
- */
872
+
2259
873
  Filters?: OperationFilter[];
2260
874
  }
2261
875
  export declare namespace ListOperationsRequest {
2262
- /**
2263
- * @internal
2264
- */
876
+
2265
877
  const filterSensitiveLog: (obj: ListOperationsRequest) => any;
2266
878
  }
2267
- /**
2268
- * <p>A complex type that contains information about an operation that matches the criteria that you specified in a
2269
- * <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_ListOperations.html">ListOperations</a>
2270
- * request.</p>
2271
- */
879
+
2272
880
  export interface OperationSummary {
2273
- /**
2274
- * <p>The ID for an operation.</p>
2275
- */
881
+
2276
882
  Id?: string;
2277
- /**
2278
- * <p>The status of the operation. Values include the following:</p>
2279
- * <ul>
2280
- * <li>
2281
- * <p>
2282
- * <b>SUBMITTED</b>: This is the initial state immediately after you submit a
2283
- * request.</p>
2284
- * </li>
2285
- * <li>
2286
- * <p>
2287
- * <b>PENDING</b>: Cloud Map is performing the operation.</p>
2288
- * </li>
2289
- * <li>
2290
- * <p>
2291
- * <b>SUCCESS</b>: The operation succeeded.</p>
2292
- * </li>
2293
- * <li>
2294
- * <p>
2295
- * <b>FAIL</b>: The operation failed. For the failure reason, see
2296
- * <code>ErrorMessage</code>.</p>
2297
- * </li>
2298
- * </ul>
2299
- */
883
+
2300
884
  Status?: OperationStatus | string;
2301
885
  }
2302
886
  export declare namespace OperationSummary {
2303
- /**
2304
- * @internal
2305
- */
887
+
2306
888
  const filterSensitiveLog: (obj: OperationSummary) => any;
2307
889
  }
2308
890
  export interface ListOperationsResponse {
2309
- /**
2310
- * <p>Summary information about the operations that match the specified criteria.</p>
2311
- */
891
+
2312
892
  Operations?: OperationSummary[];
2313
- /**
2314
- * <p>If the response contains <code>NextToken</code>, submit another <code>ListOperations</code> request to get the
2315
- * next group of results. Specify the value of <code>NextToken</code> from the previous response in the next
2316
- * request.</p>
2317
- * <note>
2318
- * <p>Cloud Map gets <code>MaxResults</code> operations and then filters them based on the specified criteria. It's
2319
- * possible that no operations in the first <code>MaxResults</code> operations matched the specified criteria but that
2320
- * subsequent groups of <code>MaxResults</code> operations do contain operations that match the criteria.</p>
2321
- * </note>
2322
- */
893
+
2323
894
  NextToken?: string;
2324
895
  }
2325
896
  export declare namespace ListOperationsResponse {
2326
- /**
2327
- * @internal
2328
- */
897
+
2329
898
  const filterSensitiveLog: (obj: ListOperationsResponse) => any;
2330
899
  }
2331
900
  export declare enum ServiceFilterName {
2332
901
  NAMESPACE_ID = "NAMESPACE_ID"
2333
902
  }
2334
- /**
2335
- * <p>A complex type that lets you specify the namespaces that you want to list services for.</p>
2336
- */
903
+
2337
904
  export interface ServiceFilter {
2338
- /**
2339
- * <p>Specify <code>NAMESPACE_ID</code>.</p>
2340
- */
905
+
2341
906
  Name: ServiceFilterName | string | undefined;
2342
- /**
2343
- * <p>The values that are applicable to the value that you specify for <code>Condition</code> to filter the list of
2344
- * services.</p>
2345
- */
907
+
2346
908
  Values: string[] | undefined;
2347
- /**
2348
- * <p>The operator that you want to use to determine whether a service is returned by <code>ListServices</code>. Valid
2349
- * values for <code>Condition</code> include the following:</p>
2350
- * <ul>
2351
- * <li>
2352
- * <p>
2353
- * <code>EQ</code>: When you specify <code>EQ</code>, specify one namespace ID for <code>Values</code>.
2354
- * <code>EQ</code> is the default condition and can be omitted.</p>
2355
- * </li>
2356
- * <li>
2357
- * <p>
2358
- * <code>IN</code>: When you specify <code>IN</code>, specify a list of the IDs for the namespaces that you want
2359
- * <code>ListServices</code> to return a list of services for.</p>
2360
- * </li>
2361
- * <li>
2362
- * <p>
2363
- * <code>BETWEEN</code>: Not applicable.</p>
2364
- * </li>
2365
- * </ul>
2366
- */
909
+
2367
910
  Condition?: FilterCondition | string;
2368
911
  }
2369
912
  export declare namespace ServiceFilter {
2370
- /**
2371
- * @internal
2372
- */
913
+
2373
914
  const filterSensitiveLog: (obj: ServiceFilter) => any;
2374
915
  }
2375
916
  export interface ListServicesRequest {
2376
- /**
2377
- * <p>For the first <code>ListServices</code> request, omit this value.</p>
2378
- * <p>If the response contains <code>NextToken</code>, submit another <code>ListServices</code> request to get the
2379
- * next group of results. Specify the value of <code>NextToken</code> from the previous response in the next
2380
- * request.</p>
2381
- * <note>
2382
- * <p>Cloud Map gets <code>MaxResults</code> services and then filters them based on the specified criteria. It's
2383
- * possible that no services in the first <code>MaxResults</code> services matched the specified criteria but that
2384
- * subsequent groups of <code>MaxResults</code> services do contain services that match the criteria.</p>
2385
- * </note>
2386
- */
917
+
2387
918
  NextToken?: string;
2388
- /**
2389
- * <p>The maximum number of services that you want Cloud Map to return in the response to a <code>ListServices</code>
2390
- * request. If you don't specify a value for <code>MaxResults</code>, Cloud Map returns up to 100 services.</p>
2391
- */
919
+
2392
920
  MaxResults?: number;
2393
- /**
2394
- * <p>A complex type that contains specifications for the namespaces that you want to list services for. </p>
2395
- * <p>If you specify more than one filter, an operation must match all filters to be returned by
2396
- * <code>ListServices</code>.</p>
2397
- */
921
+
2398
922
  Filters?: ServiceFilter[];
2399
923
  }
2400
924
  export declare namespace ListServicesRequest {
2401
- /**
2402
- * @internal
2403
- */
925
+
2404
926
  const filterSensitiveLog: (obj: ListServicesRequest) => any;
2405
927
  }
2406
- /**
2407
- * <p>A complex type that contains information about a specified service.</p>
2408
- */
928
+
2409
929
  export interface ServiceSummary {
2410
- /**
2411
- * <p>The ID that Cloud Map assigned to the service when you created it.</p>
2412
- */
930
+
2413
931
  Id?: string;
2414
- /**
2415
- * <p>The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.</p>
2416
- */
932
+
2417
933
  Arn?: string;
2418
- /**
2419
- * <p>The name of the service.</p>
2420
- */
934
+
2421
935
  Name?: string;
2422
- /**
2423
- * <p>Describes the systems that can be used to discover the service instances.</p>
2424
- * <dl>
2425
- * <dt>DNS_HTTP</dt>
2426
- * <dd>
2427
- * <p>The service instances can be discovered using either DNS queries or the <code>DiscoverInstances</code> API
2428
- * operation.</p>
2429
- * </dd>
2430
- * <dt>HTTP</dt>
2431
- * <dd>
2432
- * <p>The service instances can only be discovered using the <code>DiscoverInstances</code> API operation.</p>
2433
- * </dd>
2434
- * <dt>DNS</dt>
2435
- * <dd>
2436
- * <p>Reserved.</p>
2437
- * </dd>
2438
- * </dl>
2439
- */
936
+
2440
937
  Type?: ServiceType | string;
2441
- /**
2442
- * <p>The description that you specify when you create the service.</p>
2443
- */
938
+
2444
939
  Description?: string;
2445
- /**
2446
- * <p>The number of instances that are currently associated with the service. Instances that were previously
2447
- * associated with the service but that are deleted aren't included in the count. The count might not reflect pending
2448
- * registrations and deregistrations.</p>
2449
- */
940
+
2450
941
  InstanceCount?: number;
2451
- /**
2452
- * <p>Information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.</p>
2453
- */
942
+
2454
943
  DnsConfig?: DnsConfig;
2455
- /**
2456
- * <p>
2457
- * <i>Public DNS and HTTP namespaces only.</i> Settings for an optional health check. If you specify
2458
- * settings for a health check, Cloud Map associates the health check with the records that you specify in
2459
- * <code>DnsConfig</code>.</p>
2460
- */
944
+
2461
945
  HealthCheckConfig?: HealthCheckConfig;
2462
- /**
2463
- * <p>Information about an optional custom health check. A custom health check, which requires that you use a
2464
- * third-party health checker to evaluate the health of your resources, is useful in the following circumstances:</p>
2465
- * <ul>
2466
- * <li>
2467
- * <p>You can't use a health check that's defined by <code>HealthCheckConfig</code> because the resource isn't
2468
- * available over the internet. For example, you can use a custom health check when the instance is in an Amazon VPC.
2469
- * (To check the health of resources in a VPC, the health checker must also be in the VPC.)</p>
2470
- * </li>
2471
- * <li>
2472
- * <p>You want to use a third-party health checker regardless of where your resources are located.</p>
2473
- * </li>
2474
- * </ul>
2475
- * <important>
2476
- * <p>If you specify a health check configuration, you can specify either <code>HealthCheckCustomConfig</code> or
2477
- * <code>HealthCheckConfig</code> but not both.</p>
2478
- * </important>
2479
- */
946
+
2480
947
  HealthCheckCustomConfig?: HealthCheckCustomConfig;
2481
- /**
2482
- * <p>The date and time that the service was created.</p>
2483
- */
948
+
2484
949
  CreateDate?: Date;
2485
950
  }
2486
951
  export declare namespace ServiceSummary {
2487
- /**
2488
- * @internal
2489
- */
952
+
2490
953
  const filterSensitiveLog: (obj: ServiceSummary) => any;
2491
954
  }
2492
955
  export interface ListServicesResponse {
2493
- /**
2494
- * <p>An array that contains one <code>ServiceSummary</code> object for each service that matches the specified filter
2495
- * criteria.</p>
2496
- */
956
+
2497
957
  Services?: ServiceSummary[];
2498
- /**
2499
- * <p>If the response contains <code>NextToken</code>, submit another <code>ListServices</code> request to get the
2500
- * next group of results. Specify the value of <code>NextToken</code> from the previous response in the next
2501
- * request.</p>
2502
- * <note>
2503
- * <p>Cloud Map gets <code>MaxResults</code> services and then filters them based on the specified criteria. It's
2504
- * possible that no services in the first <code>MaxResults</code> services matched the specified criteria but that
2505
- * subsequent groups of <code>MaxResults</code> services do contain services that match the criteria.</p>
2506
- * </note>
2507
- */
958
+
2508
959
  NextToken?: string;
2509
960
  }
2510
961
  export declare namespace ListServicesResponse {
2511
- /**
2512
- * @internal
2513
- */
962
+
2514
963
  const filterSensitiveLog: (obj: ListServicesResponse) => any;
2515
964
  }
2516
965
  export interface ListTagsForResourceRequest {
2517
- /**
2518
- * <p>The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for.</p>
2519
- */
966
+
2520
967
  ResourceARN: string | undefined;
2521
968
  }
2522
969
  export declare namespace ListTagsForResourceRequest {
2523
- /**
2524
- * @internal
2525
- */
970
+
2526
971
  const filterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
2527
972
  }
2528
973
  export interface ListTagsForResourceResponse {
2529
- /**
2530
- * <p>The tags that are assigned to the resource.</p>
2531
- */
974
+
2532
975
  Tags?: Tag[];
2533
976
  }
2534
977
  export declare namespace ListTagsForResourceResponse {
2535
- /**
2536
- * @internal
2537
- */
978
+
2538
979
  const filterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
2539
980
  }
2540
- /**
2541
- * <p>The operation can't be completed because the resource was not found.</p>
2542
- */
981
+
2543
982
  export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
2544
983
  name: "ResourceNotFoundException";
2545
984
  $fault: "client";
2546
985
  Message?: string;
2547
986
  }
2548
987
  export declare namespace ResourceNotFoundException {
2549
- /**
2550
- * @internal
2551
- */
988
+
2552
989
  const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
2553
990
  }
2554
- /**
2555
- * <p>Updated Start of Authority (SOA)
2556
- * properties for a public or private DNS namespace.</p>
2557
- */
991
+
2558
992
  export interface SOAChange {
2559
- /**
2560
- * <p>The updated time to live (TTL) for
2561
- * purposes of negative caching.</p>
2562
- */
993
+
2563
994
  TTL: number | undefined;
2564
995
  }
2565
996
  export declare namespace SOAChange {
2566
- /**
2567
- * @internal
2568
- */
997
+
2569
998
  const filterSensitiveLog: (obj: SOAChange) => any;
2570
999
  }
2571
- /**
2572
- * <p>Updated DNS properties for the private
2573
- * DNS namespace.</p>
2574
- */
1000
+
2575
1001
  export interface PrivateDnsPropertiesMutableChange {
2576
- /**
2577
- * <p>Updated fields for the Start of Authority
2578
- * (SOA) record for the hosted zone for the private DNS namespace.</p>
2579
- */
1002
+
2580
1003
  SOA: SOAChange | undefined;
2581
1004
  }
2582
1005
  export declare namespace PrivateDnsPropertiesMutableChange {
2583
- /**
2584
- * @internal
2585
- */
1006
+
2586
1007
  const filterSensitiveLog: (obj: PrivateDnsPropertiesMutableChange) => any;
2587
1008
  }
2588
- /**
2589
- * <p>Updated properties for the private DNS
2590
- * namespace.</p>
2591
- */
1009
+
2592
1010
  export interface PrivateDnsNamespacePropertiesChange {
2593
- /**
2594
- * <p>Updated DNS properties for the private
2595
- * DNS namespace.</p>
2596
- */
1011
+
2597
1012
  DnsProperties: PrivateDnsPropertiesMutableChange | undefined;
2598
1013
  }
2599
1014
  export declare namespace PrivateDnsNamespacePropertiesChange {
2600
- /**
2601
- * @internal
2602
- */
1015
+
2603
1016
  const filterSensitiveLog: (obj: PrivateDnsNamespacePropertiesChange) => any;
2604
1017
  }
2605
- /**
2606
- * <p>Updated properties for the private DNS
2607
- * namespace.</p>
2608
- */
1018
+
2609
1019
  export interface PrivateDnsNamespaceChange {
2610
- /**
2611
- * <p>An updated description for the private
2612
- * DNS namespace.</p>
2613
- */
1020
+
2614
1021
  Description?: string;
2615
- /**
2616
- * <p>Properties to be updated in the private
2617
- * DNS namespace.</p>
2618
- */
1022
+
2619
1023
  Properties?: PrivateDnsNamespacePropertiesChange;
2620
1024
  }
2621
1025
  export declare namespace PrivateDnsNamespaceChange {
2622
- /**
2623
- * @internal
2624
- */
1026
+
2625
1027
  const filterSensitiveLog: (obj: PrivateDnsNamespaceChange) => any;
2626
1028
  }
2627
- /**
2628
- * <p>Updated DNS properties for the public DNS
2629
- * namespace.</p>
2630
- */
1029
+
2631
1030
  export interface PublicDnsPropertiesMutableChange {
2632
- /**
2633
- * <p>Updated fields for the Start of Authority
2634
- * (SOA) record for the hosted zone for the public DNS namespace.</p>
2635
- */
1031
+
2636
1032
  SOA: SOAChange | undefined;
2637
1033
  }
2638
1034
  export declare namespace PublicDnsPropertiesMutableChange {
2639
- /**
2640
- * @internal
2641
- */
1035
+
2642
1036
  const filterSensitiveLog: (obj: PublicDnsPropertiesMutableChange) => any;
2643
1037
  }
2644
- /**
2645
- * <p>Updated properties for the public DNS
2646
- * namespace.</p>
2647
- */
1038
+
2648
1039
  export interface PublicDnsNamespacePropertiesChange {
2649
- /**
2650
- * <p>Updated DNS properties for the hosted
2651
- * zone for the public DNS namespace.</p>
2652
- */
1040
+
2653
1041
  DnsProperties: PublicDnsPropertiesMutableChange | undefined;
2654
1042
  }
2655
1043
  export declare namespace PublicDnsNamespacePropertiesChange {
2656
- /**
2657
- * @internal
2658
- */
1044
+
2659
1045
  const filterSensitiveLog: (obj: PublicDnsNamespacePropertiesChange) => any;
2660
1046
  }
2661
- /**
2662
- * <p>Updated properties for the public DNS
2663
- * namespace.</p>
2664
- */
1047
+
2665
1048
  export interface PublicDnsNamespaceChange {
2666
- /**
2667
- * <p>An updated description for the public DNS
2668
- * namespace.</p>
2669
- */
1049
+
2670
1050
  Description?: string;
2671
- /**
2672
- * <p>Properties to be updated in the public
2673
- * DNS namespace.</p>
2674
- */
1051
+
2675
1052
  Properties?: PublicDnsNamespacePropertiesChange;
2676
1053
  }
2677
1054
  export declare namespace PublicDnsNamespaceChange {
2678
- /**
2679
- * @internal
2680
- */
1055
+
2681
1056
  const filterSensitiveLog: (obj: PublicDnsNamespaceChange) => any;
2682
1057
  }
2683
1058
  export interface RegisterInstanceRequest {
2684
- /**
2685
- * <p>The ID of the service that you want to use for settings for the instance.</p>
2686
- */
1059
+
2687
1060
  ServiceId: string | undefined;
2688
- /**
2689
- * <p>An identifier that you want to associate with the instance. Note the following:</p>
2690
- * <ul>
2691
- * <li>
2692
- * <p>If the service that's specified by <code>ServiceId</code> includes settings for an <code>SRV</code> record,
2693
- * the value of <code>InstanceId</code> is automatically included as part of the value for the <code>SRV</code>
2694
- * record. For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type">DnsRecord > Type</a>.</p>
2695
- * </li>
2696
- * <li>
2697
- * <p>You can use this value to update an existing instance.</p>
2698
- * </li>
2699
- * <li>
2700
- * <p>To register a new instance, you must specify a value that's unique among instances that you register by using
2701
- * the same service. </p>
2702
- * </li>
2703
- * <li>
2704
- * <p>If you specify an existing <code>InstanceId</code> and <code>ServiceId</code>, Cloud Map updates the existing
2705
- * DNS records, if any. If there's also an existing health check, Cloud Map deletes the old health check and creates
2706
- * a new one. </p>
2707
- * <note>
2708
- * <p>The health check isn't deleted immediately, so it will still appear for a while if you submit a
2709
- * <code>ListHealthChecks</code> request, for example.</p>
2710
- * </note>
2711
- * </li>
2712
- * </ul>
2713
- */
1061
+
2714
1062
  InstanceId: string | undefined;
2715
- /**
2716
- * <p>A unique string that identifies the request and that allows failed <code>RegisterInstance</code> requests to be
2717
- * retried without the risk of executing the operation twice. You must use a unique <code>CreatorRequestId</code> string
2718
- * every time you submit a <code>RegisterInstance</code> request if you're registering additional instances for the same
2719
- * namespace and service. <code>CreatorRequestId</code> can be any unique string (for example, a date/time
2720
- * stamp).</p>
2721
- */
1063
+
2722
1064
  CreatorRequestId?: string;
2723
- /**
2724
- * <p>A string map that contains the following information for the service that you specify in
2725
- * <code>ServiceId</code>:</p>
2726
- * <ul>
2727
- * <li>
2728
- * <p>The attributes that apply to the records that are defined in the service. </p>
2729
- * </li>
2730
- * <li>
2731
- * <p>For each attribute, the applicable value.</p>
2732
- * </li>
2733
- * </ul>
2734
- * <p>Supported attribute keys include the following:</p>
2735
- * <dl>
2736
- * <dt>AWS_ALIAS_DNS_NAME</dt>
2737
- * <dd>
2738
- * <p>If you want Cloud Map to create an Amazon Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer,
2739
- * specify the DNS name that's associated with the load balancer. For information about how to get the DNS name, see
2740
- * "DNSName" in the topic <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html">AliasTarget</a> in the <i>Route 53 API Reference</i>.</p>
2741
- * <p>Note the following:</p>
2742
- * <ul>
2743
- * <li>
2744
- * <p>The configuration for the service that's specified by <code>ServiceId</code> must include settings for an
2745
- * <code>A</code> record, an <code>AAAA</code> record, or both.</p>
2746
- * </li>
2747
- * <li>
2748
- * <p>In the service that's specified by <code>ServiceId</code>, the value of <code>RoutingPolicy</code> must be
2749
- * <code>WEIGHTED</code>.</p>
2750
- * </li>
2751
- * <li>
2752
- * <p>If the service that's specified by <code>ServiceId</code> includes <code>HealthCheckConfig</code> settings,
2753
- * Cloud Map will create the Route 53 health check, but it doesn't associate the health check with the alias
2754
- * record.</p>
2755
- * </li>
2756
- * <li>
2757
- * <p>Auto naming currently doesn't support creating alias records that route traffic to Amazon Web Services
2758
- * resources other than Elastic Load Balancing load balancers.</p>
2759
- * </li>
2760
- * <li>
2761
- * <p>If you specify a value for <code>AWS_ALIAS_DNS_NAME</code>, don't specify values for any of the
2762
- * <code>AWS_INSTANCE</code> attributes.</p>
2763
- * </li>
2764
- * </ul>
2765
- * </dd>
2766
- * <dt>AWS_EC2_INSTANCE_ID</dt>
2767
- * <dd>
2768
- * <p>
2769
- * <i>HTTP namespaces only.</i> The Amazon EC2 instance ID for the instance. If the
2770
- * <code>AWS_EC2_INSTANCE_ID</code> attribute is specified, then the only other attribute that can be specified is
2771
- * <code>AWS_INIT_HEALTH_STATUS</code>. When the <code>AWS_EC2_INSTANCE_ID</code> attribute is specified, then the
2772
- * <code>AWS_INSTANCE_IPV4</code> attribute will be filled out with the primary private IPv4 address.</p>
2773
- * </dd>
2774
- * <dt>AWS_INIT_HEALTH_STATUS</dt>
2775
- * <dd>
2776
- * <p>If the service configuration includes <code>HealthCheckCustomConfig</code>, you can optionally use
2777
- * <code>AWS_INIT_HEALTH_STATUS</code> to specify the initial status of the custom health check,
2778
- * <code>HEALTHY</code> or <code>UNHEALTHY</code>. If you don't specify a value for
2779
- * <code>AWS_INIT_HEALTH_STATUS</code>, the initial status is <code>HEALTHY</code>.</p>
2780
- * </dd>
2781
- * <dt>AWS_INSTANCE_CNAME</dt>
2782
- * <dd>
2783
- * <p>If the service configuration includes a <code>CNAME</code> record, the domain name that you want Route 53 to
2784
- * return in response to DNS queries (for example, <code>example.com</code>).</p>
2785
- * <p>This value is required if the service specified by <code>ServiceId</code> includes settings for an
2786
- * <code>CNAME</code> record.</p>
2787
- * </dd>
2788
- * <dt>AWS_INSTANCE_IPV4</dt>
2789
- * <dd>
2790
- * <p>If the service configuration includes an <code>A</code> record, the IPv4 address that you want Route 53 to
2791
- * return in response to DNS queries (for example, <code>192.0.2.44</code>).</p>
2792
- * <p>This value is required if the service specified by <code>ServiceId</code> includes settings for an
2793
- * <code>A</code> record. If the service includes settings for an <code>SRV</code> record, you must specify a value
2794
- * for <code>AWS_INSTANCE_IPV4</code>, <code>AWS_INSTANCE_IPV6</code>, or both.</p>
2795
- * </dd>
2796
- * <dt>AWS_INSTANCE_IPV6</dt>
2797
- * <dd>
2798
- * <p>If the service configuration includes an <code>AAAA</code> record, the IPv6 address that you want Route 53 to
2799
- * return in response to DNS queries (for example, <code>2001:0db8:85a3:0000:0000:abcd:0001:2345</code>).</p>
2800
- * <p>This value is required if the service specified by <code>ServiceId</code> includes settings for an
2801
- * <code>AAAA</code> record. If the service includes settings for an <code>SRV</code> record, you must specify a
2802
- * value for <code>AWS_INSTANCE_IPV4</code>, <code>AWS_INSTANCE_IPV6</code>, or both.</p>
2803
- * </dd>
2804
- * <dt>AWS_INSTANCE_PORT</dt>
2805
- * <dd>
2806
- * <p>If the service includes an <code>SRV</code> record, the value that you want Route 53 to return for the
2807
- * port.</p>
2808
- * <p>If the service includes <code>HealthCheckConfig</code>, the port on the endpoint that you want Route 53 to send
2809
- * requests to. </p>
2810
- * <p>This value is required if you specified settings for an <code>SRV</code> record or a Route 53 health check when
2811
- * you created the service.</p>
2812
- * </dd>
2813
- * <dt>Custom attributes</dt>
2814
- * <dd>
2815
- * <p>You can add up to 30 custom attributes. For each key-value pair, the maximum length of the attribute name is
2816
- * 255 characters, and the maximum length of the attribute value is 1,024 characters. The total size of all provided
2817
- * attributes (sum of all keys and values) must not exceed 5,000 characters.</p>
2818
- * </dd>
2819
- * </dl>
2820
- */
1065
+
2821
1066
  Attributes: {
2822
1067
  [key: string]: string;
2823
1068
  } | undefined;
2824
1069
  }
2825
1070
  export declare namespace RegisterInstanceRequest {
2826
- /**
2827
- * @internal
2828
- */
1071
+
2829
1072
  const filterSensitiveLog: (obj: RegisterInstanceRequest) => any;
2830
1073
  }
2831
1074
  export interface RegisterInstanceResponse {
2832
- /**
2833
- * <p>A value that you can use to determine whether the request completed successfully.
2834
- * To get the status of the operation, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html">GetOperation</a>.</p>
2835
- */
1075
+
2836
1076
  OperationId?: string;
2837
1077
  }
2838
1078
  export declare namespace RegisterInstanceResponse {
2839
- /**
2840
- * @internal
2841
- */
1079
+
2842
1080
  const filterSensitiveLog: (obj: RegisterInstanceResponse) => any;
2843
1081
  }
2844
1082
  export interface TagResourceRequest {
2845
- /**
2846
- * <p>The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for.</p>
2847
- */
1083
+
2848
1084
  ResourceARN: string | undefined;
2849
- /**
2850
- * <p>The tags to add to the specified resource. Specifying the tag key is required. You can set the value of a tag to
2851
- * an empty string, but you can't set the value of a tag to null.</p>
2852
- */
1085
+
2853
1086
  Tags: Tag[] | undefined;
2854
1087
  }
2855
1088
  export declare namespace TagResourceRequest {
2856
- /**
2857
- * @internal
2858
- */
1089
+
2859
1090
  const filterSensitiveLog: (obj: TagResourceRequest) => any;
2860
1091
  }
2861
1092
  export interface TagResourceResponse {
2862
1093
  }
2863
1094
  export declare namespace TagResourceResponse {
2864
- /**
2865
- * @internal
2866
- */
1095
+
2867
1096
  const filterSensitiveLog: (obj: TagResourceResponse) => any;
2868
1097
  }
2869
1098
  export interface UntagResourceRequest {
2870
- /**
2871
- * <p>The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for.</p>
2872
- */
1099
+
2873
1100
  ResourceARN: string | undefined;
2874
- /**
2875
- * <p>The tag keys to remove from the specified resource.</p>
2876
- */
1101
+
2877
1102
  TagKeys: string[] | undefined;
2878
1103
  }
2879
1104
  export declare namespace UntagResourceRequest {
2880
- /**
2881
- * @internal
2882
- */
1105
+
2883
1106
  const filterSensitiveLog: (obj: UntagResourceRequest) => any;
2884
1107
  }
2885
1108
  export interface UntagResourceResponse {
2886
1109
  }
2887
1110
  export declare namespace UntagResourceResponse {
2888
- /**
2889
- * @internal
2890
- */
1111
+
2891
1112
  const filterSensitiveLog: (obj: UntagResourceResponse) => any;
2892
1113
  }
2893
1114
  export interface UpdateHttpNamespaceRequest {
2894
- /**
2895
- * <p>The ID of the namespace that you want to
2896
- * update.</p>
2897
- */
1115
+
2898
1116
  Id: string | undefined;
2899
- /**
2900
- * <p>A unique string that identifies the
2901
- * request and that allows failed <code>UpdateHttpNamespace</code> requests to be retried without the risk of running
2902
- * the operation twice. <code>UpdaterRequestId</code> can be any unique string (for example, a
2903
- * date/timestamp).</p>
2904
- */
1117
+
2905
1118
  UpdaterRequestId?: string;
2906
- /**
2907
- * <p>Updated properties for the the HTTP
2908
- * namespace.</p>
2909
- */
1119
+
2910
1120
  Namespace: HttpNamespaceChange | undefined;
2911
1121
  }
2912
1122
  export declare namespace UpdateHttpNamespaceRequest {
2913
- /**
2914
- * @internal
2915
- */
1123
+
2916
1124
  const filterSensitiveLog: (obj: UpdateHttpNamespaceRequest) => any;
2917
1125
  }
2918
1126
  export interface UpdateHttpNamespaceResponse {
2919
- /**
2920
- * <p>A value that you can use to determine whether the request completed successfully.
2921
- * To get the status of the operation, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html">GetOperation</a>.</p>
2922
- */
1127
+
2923
1128
  OperationId?: string;
2924
1129
  }
2925
1130
  export declare namespace UpdateHttpNamespaceResponse {
2926
- /**
2927
- * @internal
2928
- */
1131
+
2929
1132
  const filterSensitiveLog: (obj: UpdateHttpNamespaceResponse) => any;
2930
1133
  }
2931
1134
  export interface UpdateInstanceCustomHealthStatusRequest {
2932
- /**
2933
- * <p>The ID of the service that includes the configuration for the custom health check that you want to change the
2934
- * status for.</p>
2935
- */
1135
+
2936
1136
  ServiceId: string | undefined;
2937
- /**
2938
- * <p>The ID of the instance that you want to change the health status for.</p>
2939
- */
1137
+
2940
1138
  InstanceId: string | undefined;
2941
- /**
2942
- * <p>The new status of the instance, <code>HEALTHY</code> or <code>UNHEALTHY</code>.</p>
2943
- */
1139
+
2944
1140
  Status: CustomHealthStatus | string | undefined;
2945
1141
  }
2946
1142
  export declare namespace UpdateInstanceCustomHealthStatusRequest {
2947
- /**
2948
- * @internal
2949
- */
1143
+
2950
1144
  const filterSensitiveLog: (obj: UpdateInstanceCustomHealthStatusRequest) => any;
2951
1145
  }
2952
1146
  export interface UpdatePrivateDnsNamespaceRequest {
2953
- /**
2954
- * <p>The ID of the namespace that you want to
2955
- * update.</p>
2956
- */
1147
+
2957
1148
  Id: string | undefined;
2958
- /**
2959
- * <p>A unique string that identifies the
2960
- * request and that allows failed <code>UpdatePrivateDnsNamespace</code> requests to be retried without the risk of
2961
- * running the operation twice. <code>UpdaterRequestId</code> can be any unique string (for example, a
2962
- * date/timestamp).</p>
2963
- */
1149
+
2964
1150
  UpdaterRequestId?: string;
2965
- /**
2966
- * <p>Updated properties for the private DNS
2967
- * namespace.</p>
2968
- */
1151
+
2969
1152
  Namespace: PrivateDnsNamespaceChange | undefined;
2970
1153
  }
2971
1154
  export declare namespace UpdatePrivateDnsNamespaceRequest {
2972
- /**
2973
- * @internal
2974
- */
1155
+
2975
1156
  const filterSensitiveLog: (obj: UpdatePrivateDnsNamespaceRequest) => any;
2976
1157
  }
2977
1158
  export interface UpdatePrivateDnsNamespaceResponse {
2978
- /**
2979
- * <p>A value that you can use to determine whether the request completed successfully.
2980
- * To get the status of the operation, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html">GetOperation</a>.</p>
2981
- */
1159
+
2982
1160
  OperationId?: string;
2983
1161
  }
2984
1162
  export declare namespace UpdatePrivateDnsNamespaceResponse {
2985
- /**
2986
- * @internal
2987
- */
1163
+
2988
1164
  const filterSensitiveLog: (obj: UpdatePrivateDnsNamespaceResponse) => any;
2989
1165
  }
2990
1166
  export interface UpdatePublicDnsNamespaceRequest {
2991
- /**
2992
- * <p>The ID of the namespace being
2993
- * updated.</p>
2994
- */
1167
+
2995
1168
  Id: string | undefined;
2996
- /**
2997
- * <p>A unique string that identifies the
2998
- * request and that allows failed <code>UpdatePublicDnsNamespace</code> requests to be retried without the risk of
2999
- * running the operation twice. <code>UpdaterRequestId</code> can be any unique string (for example, a
3000
- * date/timestamp).</p>
3001
- */
1169
+
3002
1170
  UpdaterRequestId?: string;
3003
- /**
3004
- * <p>Updated properties for the public DNS
3005
- * namespace.</p>
3006
- */
1171
+
3007
1172
  Namespace: PublicDnsNamespaceChange | undefined;
3008
1173
  }
3009
1174
  export declare namespace UpdatePublicDnsNamespaceRequest {
3010
- /**
3011
- * @internal
3012
- */
1175
+
3013
1176
  const filterSensitiveLog: (obj: UpdatePublicDnsNamespaceRequest) => any;
3014
1177
  }
3015
1178
  export interface UpdatePublicDnsNamespaceResponse {
3016
- /**
3017
- * <p>A value that you can use to determine whether the request completed successfully.
3018
- * To get the status of the operation, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html">GetOperation</a>.</p>
3019
- */
1179
+
3020
1180
  OperationId?: string;
3021
1181
  }
3022
1182
  export declare namespace UpdatePublicDnsNamespaceResponse {
3023
- /**
3024
- * @internal
3025
- */
1183
+
3026
1184
  const filterSensitiveLog: (obj: UpdatePublicDnsNamespaceResponse) => any;
3027
1185
  }
3028
- /**
3029
- * <p>A complex type that contains changes to an existing service.</p>
3030
- */
1186
+
3031
1187
  export interface ServiceChange {
3032
- /**
3033
- * <p>A description for the service.</p>
3034
- */
1188
+
3035
1189
  Description?: string;
3036
- /**
3037
- * <p>Information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.</p>
3038
- */
1190
+
3039
1191
  DnsConfig?: DnsConfigChange;
3040
- /**
3041
- * <p>
3042
- * <i>Public DNS and HTTP namespaces only.</i> Settings for an optional health check. If you specify
3043
- * settings for a health check, Cloud Map associates the health check with the records that you specify in
3044
- * <code>DnsConfig</code>.</p>
3045
- */
1192
+
3046
1193
  HealthCheckConfig?: HealthCheckConfig;
3047
1194
  }
3048
1195
  export declare namespace ServiceChange {
3049
- /**
3050
- * @internal
3051
- */
1196
+
3052
1197
  const filterSensitiveLog: (obj: ServiceChange) => any;
3053
1198
  }
3054
1199
  export interface UpdateServiceRequest {
3055
- /**
3056
- * <p>The ID of the service that you want to update.</p>
3057
- */
1200
+
3058
1201
  Id: string | undefined;
3059
- /**
3060
- * <p>A complex type that contains the new settings for the service.</p>
3061
- */
1202
+
3062
1203
  Service: ServiceChange | undefined;
3063
1204
  }
3064
1205
  export declare namespace UpdateServiceRequest {
3065
- /**
3066
- * @internal
3067
- */
1206
+
3068
1207
  const filterSensitiveLog: (obj: UpdateServiceRequest) => any;
3069
1208
  }
3070
1209
  export interface UpdateServiceResponse {
3071
- /**
3072
- * <p>A value that you can use to determine whether the request completed successfully.
3073
- * To get the status of the operation, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html">GetOperation</a>.</p>
3074
- */
1210
+
3075
1211
  OperationId?: string;
3076
1212
  }
3077
1213
  export declare namespace UpdateServiceResponse {
3078
- /**
3079
- * @internal
3080
- */
1214
+
3081
1215
  const filterSensitiveLog: (obj: UpdateServiceResponse) => any;
3082
1216
  }