@aws-sdk/client-servicediscovery 3.379.1 → 3.385.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -6,10 +6,12 @@ import { ServiceDiscoveryServiceException as __BaseException } from "./ServiceDi
6
6
  */
7
7
  export interface Tag {
8
8
  /**
9
+ * @public
9
10
  * <p>The key identifier, or name, of the tag.</p>
10
11
  */
11
12
  Key: string | undefined;
12
13
  /**
14
+ * @public
13
15
  * <p>The string value that's associated with the key of the tag. You can set the value of a tag
14
16
  * to an empty string, but you can't set the value of a tag to null.</p>
15
17
  */
@@ -20,10 +22,12 @@ export interface Tag {
20
22
  */
21
23
  export interface CreateHttpNamespaceRequest {
22
24
  /**
25
+ * @public
23
26
  * <p>The name that you want to assign to this namespace.</p>
24
27
  */
25
28
  Name: string | undefined;
26
29
  /**
30
+ * @public
27
31
  * <p>A unique string that identifies the request and that allows failed
28
32
  * <code>CreateHttpNamespace</code> requests to be retried without the risk of running the
29
33
  * operation twice. <code>CreatorRequestId</code> can be any unique string (for example, a date/time
@@ -31,10 +35,12 @@ export interface CreateHttpNamespaceRequest {
31
35
  */
32
36
  CreatorRequestId?: string;
33
37
  /**
38
+ * @public
34
39
  * <p>A description for the namespace.</p>
35
40
  */
36
41
  Description?: string;
37
42
  /**
43
+ * @public
38
44
  * <p>The tags to add to the namespace. Each tag consists of a key and an optional value that you
39
45
  * define. Tags keys can be up to 128 characters in length, and tag values can be up to 256
40
46
  * characters in length.</p>
@@ -46,6 +52,7 @@ export interface CreateHttpNamespaceRequest {
46
52
  */
47
53
  export interface CreateHttpNamespaceResponse {
48
54
  /**
55
+ * @public
49
56
  * <p>A value that you can use to determine whether the request completed successfully.
50
57
  * 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>
51
58
  */
@@ -60,6 +67,7 @@ export declare class DuplicateRequest extends __BaseException {
60
67
  readonly $fault: "client";
61
68
  Message?: string;
62
69
  /**
70
+ * @public
63
71
  * <p>The ID of the operation that's already in progress.</p>
64
72
  */
65
73
  DuplicateOperationId?: string;
@@ -92,10 +100,12 @@ export declare class NamespaceAlreadyExists extends __BaseException {
92
100
  readonly $fault: "client";
93
101
  Message?: string;
94
102
  /**
103
+ * @public
95
104
  * <p>The <code>CreatorRequestId</code> that was used to create the namespace.</p>
96
105
  */
97
106
  CreatorRequestId?: string;
98
107
  /**
108
+ * @public
99
109
  * <p>The ID of the existing namespace.</p>
100
110
  */
101
111
  NamespaceId?: string;
@@ -128,6 +138,7 @@ export declare class TooManyTagsException extends __BaseException {
128
138
  readonly $fault: "client";
129
139
  Message?: string;
130
140
  /**
141
+ * @public
131
142
  * <p>The name of the resource.</p>
132
143
  */
133
144
  ResourceName?: string;
@@ -143,6 +154,7 @@ export declare class TooManyTagsException extends __BaseException {
143
154
  */
144
155
  export interface SOA {
145
156
  /**
157
+ * @public
146
158
  * <p>The time to live
147
159
  * (TTL) for purposes of negative caching.</p>
148
160
  */
@@ -155,6 +167,7 @@ export interface SOA {
155
167
  */
156
168
  export interface PrivateDnsPropertiesMutable {
157
169
  /**
170
+ * @public
158
171
  * <p>Fields for the Start
159
172
  * of Authority (SOA) record for the hosted zone for the private DNS
160
173
  * namespace.</p>
@@ -168,6 +181,7 @@ export interface PrivateDnsPropertiesMutable {
168
181
  */
169
182
  export interface PrivateDnsNamespaceProperties {
170
183
  /**
184
+ * @public
171
185
  * <p>DNS properties for
172
186
  * the private DNS namespace.</p>
173
187
  */
@@ -178,12 +192,14 @@ export interface PrivateDnsNamespaceProperties {
178
192
  */
179
193
  export interface CreatePrivateDnsNamespaceRequest {
180
194
  /**
195
+ * @public
181
196
  * <p>The name that you want to assign to this namespace. When you create a private DNS namespace,
182
197
  * Cloud Map automatically creates an Amazon Route 53 private hosted zone that has the same name as the
183
198
  * namespace.</p>
184
199
  */
185
200
  Name: string | undefined;
186
201
  /**
202
+ * @public
187
203
  * <p>A unique string that identifies the request and that allows failed
188
204
  * <code>CreatePrivateDnsNamespace</code> requests to be retried without the risk of running the
189
205
  * operation twice. <code>CreatorRequestId</code> can be any unique string (for example, a
@@ -191,20 +207,24 @@ export interface CreatePrivateDnsNamespaceRequest {
191
207
  */
192
208
  CreatorRequestId?: string;
193
209
  /**
210
+ * @public
194
211
  * <p>A description for the namespace.</p>
195
212
  */
196
213
  Description?: string;
197
214
  /**
215
+ * @public
198
216
  * <p>The ID of the Amazon VPC that you want to associate the namespace with.</p>
199
217
  */
200
218
  Vpc: string | undefined;
201
219
  /**
220
+ * @public
202
221
  * <p>The tags to add to the namespace. Each tag consists of a key and an optional value that you
203
222
  * define. Tags keys can be up to 128 characters in length, and tag values can be up to 256
204
223
  * characters in length.</p>
205
224
  */
206
225
  Tags?: Tag[];
207
226
  /**
227
+ * @public
208
228
  * <p>Properties for the
209
229
  * private DNS namespace.</p>
210
230
  */
@@ -215,6 +235,7 @@ export interface CreatePrivateDnsNamespaceRequest {
215
235
  */
216
236
  export interface CreatePrivateDnsNamespaceResponse {
217
237
  /**
238
+ * @public
218
239
  * <p>A value that you can use to determine whether the request completed successfully.
219
240
  * 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>
220
241
  */
@@ -227,6 +248,7 @@ export interface CreatePrivateDnsNamespaceResponse {
227
248
  */
228
249
  export interface PublicDnsPropertiesMutable {
229
250
  /**
251
+ * @public
230
252
  * <p>Start of Authority
231
253
  * (SOA) record for the hosted zone for the public DNS namespace.</p>
232
254
  */
@@ -239,6 +261,7 @@ export interface PublicDnsPropertiesMutable {
239
261
  */
240
262
  export interface PublicDnsNamespaceProperties {
241
263
  /**
264
+ * @public
242
265
  * <p>DNS properties for
243
266
  * the public DNS namespace.</p>
244
267
  */
@@ -249,6 +272,7 @@ export interface PublicDnsNamespaceProperties {
249
272
  */
250
273
  export interface CreatePublicDnsNamespaceRequest {
251
274
  /**
275
+ * @public
252
276
  * <p>The name that you want to assign to this namespace.</p>
253
277
  * <note>
254
278
  * <p>Do not include sensitive information in the name. The name is publicly available using DNS queries.</p>
@@ -256,6 +280,7 @@ export interface CreatePublicDnsNamespaceRequest {
256
280
  */
257
281
  Name: string | undefined;
258
282
  /**
283
+ * @public
259
284
  * <p>A unique string that identifies the request and that allows failed
260
285
  * <code>CreatePublicDnsNamespace</code> requests to be retried without the risk of running the
261
286
  * operation twice. <code>CreatorRequestId</code> can be any unique string (for example, a
@@ -263,16 +288,19 @@ export interface CreatePublicDnsNamespaceRequest {
263
288
  */
264
289
  CreatorRequestId?: string;
265
290
  /**
291
+ * @public
266
292
  * <p>A description for the namespace.</p>
267
293
  */
268
294
  Description?: string;
269
295
  /**
296
+ * @public
270
297
  * <p>The tags to add to the namespace. Each tag consists of a key and an optional value that you
271
298
  * define. Tags keys can be up to 128 characters in length, and tag values can be up to 256
272
299
  * characters in length.</p>
273
300
  */
274
301
  Tags?: Tag[];
275
302
  /**
303
+ * @public
276
304
  * <p>Properties for the
277
305
  * public DNS namespace.</p>
278
306
  */
@@ -283,6 +311,7 @@ export interface CreatePublicDnsNamespaceRequest {
283
311
  */
284
312
  export interface CreatePublicDnsNamespaceResponse {
285
313
  /**
314
+ * @public
286
315
  * <p>A value that you can use to determine whether the request completed successfully. To get the
287
316
  * status of the operation, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html">GetOperation</a>.</p>
288
317
  */
@@ -309,6 +338,7 @@ export type RecordType = (typeof RecordType)[keyof typeof RecordType];
309
338
  */
310
339
  export interface DnsRecord {
311
340
  /**
341
+ * @public
312
342
  * <p>The type of the resource, which indicates the type of value that Route 53 returns in response
313
343
  * to DNS queries. You can specify values for <code>Type</code> in the following
314
344
  * combinations:</p>
@@ -448,6 +478,7 @@ export interface DnsRecord {
448
478
  */
449
479
  Type: RecordType | string | undefined;
450
480
  /**
481
+ * @public
451
482
  * <p>The amount of time, in seconds, that you want DNS resolvers to cache the settings for this
452
483
  * record.</p>
453
484
  * <note>
@@ -483,6 +514,7 @@ export type RoutingPolicy = (typeof RoutingPolicy)[keyof typeof RoutingPolicy];
483
514
  */
484
515
  export interface DnsConfig {
485
516
  /**
517
+ * @public
486
518
  * @deprecated
487
519
  *
488
520
  * <p>
@@ -493,6 +525,7 @@ export interface DnsConfig {
493
525
  */
494
526
  NamespaceId?: string;
495
527
  /**
528
+ * @public
496
529
  * <p>The routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates
497
530
  * when you register an instance and specify this service.</p>
498
531
  * <note>
@@ -534,6 +567,7 @@ export interface DnsConfig {
534
567
  */
535
568
  RoutingPolicy?: RoutingPolicy | string;
536
569
  /**
570
+ * @public
537
571
  * <p>An array that contains one <code>DnsRecord</code> object for each Route 53 DNS record that you
538
572
  * want Cloud Map to create when you register an instance.</p>
539
573
  */
@@ -619,6 +653,7 @@ export type HealthCheckType = (typeof HealthCheckType)[keyof typeof HealthCheckT
619
653
  */
620
654
  export interface HealthCheckConfig {
621
655
  /**
656
+ * @public
622
657
  * <p>The type of health check that you want to create, which indicates how Route 53 determines
623
658
  * whether an endpoint is healthy.</p>
624
659
  * <important>
@@ -655,6 +690,7 @@ export interface HealthCheckConfig {
655
690
  */
656
691
  Type: HealthCheckType | string | undefined;
657
692
  /**
693
+ * @public
658
694
  * <p>The path that you want Route 53 to request when performing health checks. The path can be any
659
695
  * value that your endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint
660
696
  * is healthy. An example file is <code>/docs/route53-health-check.html</code>. Route 53 automatically
@@ -665,6 +701,7 @@ export interface HealthCheckConfig {
665
701
  */
666
702
  ResourcePath?: string;
667
703
  /**
704
+ * @public
668
705
  * <p>The number of consecutive health checks that an endpoint must pass or fail for Route 53 to
669
706
  * change the current status of the endpoint from unhealthy to healthy or the other way around. For
670
707
  * more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html">How Route 53
@@ -732,6 +769,7 @@ export interface HealthCheckConfig {
732
769
  */
733
770
  export interface HealthCheckCustomConfig {
734
771
  /**
772
+ * @public
735
773
  * @deprecated
736
774
  *
737
775
  * <important>
@@ -764,6 +802,7 @@ export type ServiceTypeOption = (typeof ServiceTypeOption)[keyof typeof ServiceT
764
802
  */
765
803
  export interface CreateServiceRequest {
766
804
  /**
805
+ * @public
767
806
  * <p>The name that you want to assign to the service.</p>
768
807
  * <note>
769
808
  * <p>Do not include sensitive information in the name if the namespace is discoverable by public DNS queries.</p>
@@ -791,11 +830,13 @@ export interface CreateServiceRequest {
791
830
  */
792
831
  Name: string | undefined;
793
832
  /**
833
+ * @public
794
834
  * <p>The ID of the namespace that you want to use to create the service. The namespace ID must be
795
835
  * specified, but it can be specified either here or in the <code>DnsConfig</code> object.</p>
796
836
  */
797
837
  NamespaceId?: string;
798
838
  /**
839
+ * @public
799
840
  * <p>A unique string that identifies the request and that allows failed
800
841
  * <code>CreateService</code> requests to be retried without the risk of running the operation
801
842
  * twice. <code>CreatorRequestId</code> can be any unique string (for example, a
@@ -803,15 +844,18 @@ export interface CreateServiceRequest {
803
844
  */
804
845
  CreatorRequestId?: string;
805
846
  /**
847
+ * @public
806
848
  * <p>A description for the service.</p>
807
849
  */
808
850
  Description?: string;
809
851
  /**
852
+ * @public
810
853
  * <p>A complex type that contains information about the Amazon Route 53 records that you want
811
854
  * Cloud Map to create when you register an instance. </p>
812
855
  */
813
856
  DnsConfig?: DnsConfig;
814
857
  /**
858
+ * @public
815
859
  * <p>
816
860
  * <i>Public DNS and HTTP namespaces only.</i> A complex type that contains
817
861
  * settings for an optional Route 53 health check. If you specify settings for a health check,
@@ -825,6 +869,7 @@ export interface CreateServiceRequest {
825
869
  */
826
870
  HealthCheckConfig?: HealthCheckConfig;
827
871
  /**
872
+ * @public
828
873
  * <p>A complex type that contains information about an optional custom health check.</p>
829
874
  * <important>
830
875
  * <p>If you specify a health check configuration, you can specify either
@@ -835,12 +880,14 @@ export interface CreateServiceRequest {
835
880
  */
836
881
  HealthCheckCustomConfig?: HealthCheckCustomConfig;
837
882
  /**
883
+ * @public
838
884
  * <p>The tags to add to the service. Each tag consists of a key and an optional value that you
839
885
  * define. Tags keys can be up to 128 characters in length, and tag values can be up to 256
840
886
  * characters in length.</p>
841
887
  */
842
888
  Tags?: Tag[];
843
889
  /**
890
+ * @public
844
891
  * <p>If present, specifies that the service instances are only discoverable using the
845
892
  * <code>DiscoverInstances</code> API operation. No DNS records is registered for the service
846
893
  * instances. The only valid value is <code>HTTP</code>.</p>
@@ -866,32 +913,39 @@ export type ServiceType = (typeof ServiceType)[keyof typeof ServiceType];
866
913
  */
867
914
  export interface Service {
868
915
  /**
916
+ * @public
869
917
  * <p>The ID that Cloud Map assigned to the service when you created it.</p>
870
918
  */
871
919
  Id?: string;
872
920
  /**
921
+ * @public
873
922
  * <p>The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.</p>
874
923
  */
875
924
  Arn?: string;
876
925
  /**
926
+ * @public
877
927
  * <p>The name of the service.</p>
878
928
  */
879
929
  Name?: string;
880
930
  /**
931
+ * @public
881
932
  * <p>The ID of the namespace that was used to create the service.</p>
882
933
  */
883
934
  NamespaceId?: string;
884
935
  /**
936
+ * @public
885
937
  * <p>The description of the service.</p>
886
938
  */
887
939
  Description?: string;
888
940
  /**
941
+ * @public
889
942
  * <p>The number of instances that are currently associated with the service. Instances that were
890
943
  * previously associated with the service but that are deleted aren't included in the count. The
891
944
  * count might not reflect pending registrations and deregistrations.</p>
892
945
  */
893
946
  InstanceCount?: number;
894
947
  /**
948
+ * @public
895
949
  * <p>A complex type that contains information about the Route 53 DNS records that you want
896
950
  * Cloud Map to create when you register an instance.</p>
897
951
  * <important>
@@ -901,6 +955,7 @@ export interface Service {
901
955
  */
902
956
  DnsConfig?: DnsConfig;
903
957
  /**
958
+ * @public
904
959
  * <p>Describes the systems that can be used to discover the service instances.</p>
905
960
  * <dl>
906
961
  * <dt>DNS_HTTP</dt>
@@ -921,6 +976,7 @@ export interface Service {
921
976
  */
922
977
  Type?: ServiceType | string;
923
978
  /**
979
+ * @public
924
980
  * <p>
925
981
  * <i>Public DNS and HTTP namespaces only.</i> A complex type that contains
926
982
  * settings for an optional health check. If you specify settings for a health check, Cloud Map
@@ -929,6 +985,7 @@ export interface Service {
929
985
  */
930
986
  HealthCheckConfig?: HealthCheckConfig;
931
987
  /**
988
+ * @public
932
989
  * <p>A complex type that contains information about an optional custom health check.</p>
933
990
  * <important>
934
991
  * <p>If you specify a health check configuration, you can specify either
@@ -937,12 +994,14 @@ export interface Service {
937
994
  */
938
995
  HealthCheckCustomConfig?: HealthCheckCustomConfig;
939
996
  /**
997
+ * @public
940
998
  * <p>The date and time that the service was created, in Unix format and Coordinated Universal
941
999
  * Time (UTC). The value of <code>CreateDate</code> is accurate to milliseconds. For example, the
942
1000
  * value <code>1516925490.087</code> represents Friday, January 26, 2018 12:11:30.087 AM.</p>
943
1001
  */
944
1002
  CreateDate?: Date;
945
1003
  /**
1004
+ * @public
946
1005
  * <p>A unique string that identifies the request and that allows failed requests to be retried
947
1006
  * without the risk of running the operation twice. <code>CreatorRequestId</code> can be any unique
948
1007
  * string (for example, a date/timestamp).</p>
@@ -954,6 +1013,7 @@ export interface Service {
954
1013
  */
955
1014
  export interface CreateServiceResponse {
956
1015
  /**
1016
+ * @public
957
1017
  * <p>A complex type that contains information about the new service.</p>
958
1018
  */
959
1019
  Service?: Service;
@@ -980,10 +1040,12 @@ export declare class ServiceAlreadyExists extends __BaseException {
980
1040
  readonly $fault: "client";
981
1041
  Message?: string;
982
1042
  /**
1043
+ * @public
983
1044
  * <p>The <code>CreatorRequestId</code> that was used to create the service.</p>
984
1045
  */
985
1046
  CreatorRequestId?: string;
986
1047
  /**
1048
+ * @public
987
1049
  * <p>The ID of the existing service.</p>
988
1050
  */
989
1051
  ServiceId?: string;
@@ -1023,6 +1085,7 @@ export type CustomHealthStatus = (typeof CustomHealthStatus)[keyof typeof Custom
1023
1085
  */
1024
1086
  export interface DeleteNamespaceRequest {
1025
1087
  /**
1088
+ * @public
1026
1089
  * <p>The ID of the namespace that you want to delete.</p>
1027
1090
  */
1028
1091
  Id: string | undefined;
@@ -1032,6 +1095,7 @@ export interface DeleteNamespaceRequest {
1032
1095
  */
1033
1096
  export interface DeleteNamespaceResponse {
1034
1097
  /**
1098
+ * @public
1035
1099
  * <p>A value that you can use to determine whether the request completed successfully.
1036
1100
  * 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>
1037
1101
  */
@@ -1056,6 +1120,7 @@ export declare class ResourceInUse extends __BaseException {
1056
1120
  */
1057
1121
  export interface DeleteServiceRequest {
1058
1122
  /**
1123
+ * @public
1059
1124
  * <p>The ID of the service that you want to delete.</p>
1060
1125
  */
1061
1126
  Id: string | undefined;
@@ -1083,10 +1148,12 @@ export declare class ServiceNotFound extends __BaseException {
1083
1148
  */
1084
1149
  export interface DeregisterInstanceRequest {
1085
1150
  /**
1151
+ * @public
1086
1152
  * <p>The ID of the service that the instance is associated with.</p>
1087
1153
  */
1088
1154
  ServiceId: string | undefined;
1089
1155
  /**
1156
+ * @public
1090
1157
  * <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>
1091
1158
  */
1092
1159
  InstanceId: string | undefined;
@@ -1096,6 +1163,7 @@ export interface DeregisterInstanceRequest {
1096
1163
  */
1097
1164
  export interface DeregisterInstanceResponse {
1098
1165
  /**
1166
+ * @public
1099
1167
  * <p>A value that you can use to determine whether the request completed successfully.
1100
1168
  * 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>
1101
1169
  */
@@ -1134,28 +1202,33 @@ export type HealthStatusFilter = (typeof HealthStatusFilter)[keyof typeof Health
1134
1202
  */
1135
1203
  export interface DiscoverInstancesRequest {
1136
1204
  /**
1205
+ * @public
1137
1206
  * <p>The <code>HttpName</code> name of the namespace. It's found in the
1138
1207
  * <code>HttpProperties</code> member of the <code>Properties</code> member of the
1139
1208
  * namespace.</p>
1140
1209
  */
1141
1210
  NamespaceName: string | undefined;
1142
1211
  /**
1212
+ * @public
1143
1213
  * <p>The name of the service that you specified when you registered the instance.</p>
1144
1214
  */
1145
1215
  ServiceName: string | undefined;
1146
1216
  /**
1217
+ * @public
1147
1218
  * <p>The maximum number of instances that you want Cloud Map to return in the response to a
1148
1219
  * <code>DiscoverInstances</code> request. If you don't specify a value for
1149
1220
  * <code>MaxResults</code>, Cloud Map returns up to 100 instances.</p>
1150
1221
  */
1151
1222
  MaxResults?: number;
1152
1223
  /**
1224
+ * @public
1153
1225
  * <p>Filters to scope the results based on custom attributes for the instance (for example,
1154
1226
  * <code>\{version=v1, az=1a\}</code>). Only instances that match all the specified key-value pairs
1155
1227
  * are returned.</p>
1156
1228
  */
1157
1229
  QueryParameters?: Record<string, string>;
1158
1230
  /**
1231
+ * @public
1159
1232
  * <p>Opportunistic filters to scope the results based on custom attributes. If there are
1160
1233
  * instances that match both the filters specified in both the <code>QueryParameters</code>
1161
1234
  * parameter and this parameter, all of these instances are returned. Otherwise, the filters are
@@ -1164,6 +1237,7 @@ export interface DiscoverInstancesRequest {
1164
1237
  */
1165
1238
  OptionalParameters?: Record<string, string>;
1166
1239
  /**
1240
+ * @public
1167
1241
  * <p>The health status of the instances that you want to discover. This parameter is ignored for
1168
1242
  * services that don't have a health check configured, and
1169
1243
  * all
@@ -1211,10 +1285,12 @@ export type HealthStatus = (typeof HealthStatus)[keyof typeof HealthStatus];
1211
1285
  */
1212
1286
  export interface HttpInstanceSummary {
1213
1287
  /**
1288
+ * @public
1214
1289
  * <p>The ID of an instance that matches the values that you specified in the request.</p>
1215
1290
  */
1216
1291
  InstanceId?: string;
1217
1292
  /**
1293
+ * @public
1218
1294
  * <p>
1219
1295
  * <code></code>
1220
1296
  * <code></code>
@@ -1226,15 +1302,18 @@ export interface HttpInstanceSummary {
1226
1302
  */
1227
1303
  NamespaceName?: string;
1228
1304
  /**
1305
+ * @public
1229
1306
  * <p>The name of the service that you specified when you registered the instance.</p>
1230
1307
  */
1231
1308
  ServiceName?: string;
1232
1309
  /**
1310
+ * @public
1233
1311
  * <p>If you configured health checking in the service, the current health status of the service
1234
1312
  * instance.</p>
1235
1313
  */
1236
1314
  HealthStatus?: HealthStatus | string;
1237
1315
  /**
1316
+ * @public
1238
1317
  * <p>If you included any attributes when you registered the instance, the values of those
1239
1318
  * attributes.</p>
1240
1319
  */
@@ -1245,6 +1324,7 @@ export interface HttpInstanceSummary {
1245
1324
  */
1246
1325
  export interface DiscoverInstancesResponse {
1247
1326
  /**
1327
+ * @public
1248
1328
  * <p>A complex type that contains one <code>HttpInstanceSummary</code> for each registered
1249
1329
  * instance.</p>
1250
1330
  */
@@ -1272,6 +1352,7 @@ export declare class RequestLimitExceeded extends __BaseException {
1272
1352
  */
1273
1353
  export interface DnsConfigChange {
1274
1354
  /**
1355
+ * @public
1275
1356
  * <p>An array that contains one <code>DnsRecord</code> object for each Route 53 record that you want
1276
1357
  * Cloud Map to create when you register an instance.</p>
1277
1358
  */
@@ -1284,10 +1365,12 @@ export interface DnsConfigChange {
1284
1365
  */
1285
1366
  export interface DnsProperties {
1286
1367
  /**
1368
+ * @public
1287
1369
  * <p>The ID for the Route 53 hosted zone that Cloud Map creates when you create a namespace.</p>
1288
1370
  */
1289
1371
  HostedZoneId?: string;
1290
1372
  /**
1373
+ * @public
1291
1374
  * <p>Start of Authority (SOA) record for the hosted zone.</p>
1292
1375
  */
1293
1376
  SOA?: SOA;
@@ -1311,10 +1394,12 @@ export type FilterCondition = (typeof FilterCondition)[keyof typeof FilterCondit
1311
1394
  */
1312
1395
  export interface GetInstanceRequest {
1313
1396
  /**
1397
+ * @public
1314
1398
  * <p>The ID of the service that the instance is associated with.</p>
1315
1399
  */
1316
1400
  ServiceId: string | undefined;
1317
1401
  /**
1402
+ * @public
1318
1403
  * <p>The ID of the instance that you want to get information about.</p>
1319
1404
  */
1320
1405
  InstanceId: string | undefined;
@@ -1326,6 +1411,7 @@ export interface GetInstanceRequest {
1326
1411
  */
1327
1412
  export interface Instance {
1328
1413
  /**
1414
+ * @public
1329
1415
  * <p>An identifier that you want to associate with the instance. Note the following:</p>
1330
1416
  * <ul>
1331
1417
  * <li>
@@ -1354,6 +1440,7 @@ export interface Instance {
1354
1440
  */
1355
1441
  Id: string | undefined;
1356
1442
  /**
1443
+ * @public
1357
1444
  * <p>A unique string that identifies the request and that allows failed
1358
1445
  * <code>RegisterInstance</code> requests to be retried without the risk of executing the operation
1359
1446
  * twice. You must use a unique <code>CreatorRequestId</code> string every time you submit a
@@ -1363,6 +1450,7 @@ export interface Instance {
1363
1450
  */
1364
1451
  CreatorRequestId?: string;
1365
1452
  /**
1453
+ * @public
1366
1454
  * <p>A string map that contains the following information for the service that you specify in
1367
1455
  * <code>ServiceId</code>:</p>
1368
1456
  * <ul>
@@ -1467,6 +1555,7 @@ export interface Instance {
1467
1555
  */
1468
1556
  export interface GetInstanceResponse {
1469
1557
  /**
1558
+ * @public
1470
1559
  * <p>A complex type that contains information about a specified instance.</p>
1471
1560
  */
1472
1561
  Instance?: Instance;
@@ -1476,10 +1565,12 @@ export interface GetInstanceResponse {
1476
1565
  */
1477
1566
  export interface GetInstancesHealthStatusRequest {
1478
1567
  /**
1568
+ * @public
1479
1569
  * <p>The ID of the service that the instance is associated with.</p>
1480
1570
  */
1481
1571
  ServiceId: string | undefined;
1482
1572
  /**
1573
+ * @public
1483
1574
  * <p>An array that contains the IDs of all the instances that you want to get the health status
1484
1575
  * for.</p>
1485
1576
  * <p>If you omit <code>Instances</code>, Cloud Map returns the health status for all the
@@ -1491,12 +1582,14 @@ export interface GetInstancesHealthStatusRequest {
1491
1582
  */
1492
1583
  Instances?: string[];
1493
1584
  /**
1585
+ * @public
1494
1586
  * <p>The maximum number of instances that you want Cloud Map to return in the response to a
1495
1587
  * <code>GetInstancesHealthStatus</code> request. If you don't specify a value for
1496
1588
  * <code>MaxResults</code>, Cloud Map returns up to 100 instances.</p>
1497
1589
  */
1498
1590
  MaxResults?: number;
1499
1591
  /**
1592
+ * @public
1500
1593
  * <p>For the first <code>GetInstancesHealthStatus</code> request, omit this value.</p>
1501
1594
  * <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit
1502
1595
  * another <code>GetInstancesHealthStatus</code> request to get the next group of results. Specify
@@ -1509,11 +1602,13 @@ export interface GetInstancesHealthStatusRequest {
1509
1602
  */
1510
1603
  export interface GetInstancesHealthStatusResponse {
1511
1604
  /**
1605
+ * @public
1512
1606
  * <p>A complex type that contains the IDs and the health status of the instances that you
1513
1607
  * specified in the <code>GetInstancesHealthStatus</code> request.</p>
1514
1608
  */
1515
1609
  Status?: Record<string, HealthStatus | string>;
1516
1610
  /**
1611
+ * @public
1517
1612
  * <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit
1518
1613
  * another <code>GetInstancesHealthStatus</code> request to get the next group of results. Specify
1519
1614
  * the value of <code>NextToken</code> from the previous response in the next request.</p>
@@ -1525,6 +1620,7 @@ export interface GetInstancesHealthStatusResponse {
1525
1620
  */
1526
1621
  export interface GetNamespaceRequest {
1527
1622
  /**
1623
+ * @public
1528
1624
  * <p>The ID of the namespace that you want to get information about.</p>
1529
1625
  */
1530
1626
  Id: string | undefined;
@@ -1535,6 +1631,7 @@ export interface GetNamespaceRequest {
1535
1631
  */
1536
1632
  export interface HttpProperties {
1537
1633
  /**
1634
+ * @public
1538
1635
  * <p>The name of an HTTP namespace.</p>
1539
1636
  */
1540
1637
  HttpName?: string;
@@ -1545,11 +1642,13 @@ export interface HttpProperties {
1545
1642
  */
1546
1643
  export interface NamespaceProperties {
1547
1644
  /**
1645
+ * @public
1548
1646
  * <p>A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when
1549
1647
  * you create a namespace.</p>
1550
1648
  */
1551
1649
  DnsProperties?: DnsProperties;
1552
1650
  /**
1651
+ * @public
1553
1652
  * <p>A complex type that contains the name of an HTTP namespace.</p>
1554
1653
  */
1555
1654
  HttpProperties?: HttpProperties;
@@ -1573,18 +1672,22 @@ export type NamespaceType = (typeof NamespaceType)[keyof typeof NamespaceType];
1573
1672
  */
1574
1673
  export interface Namespace {
1575
1674
  /**
1675
+ * @public
1576
1676
  * <p>The ID of a namespace.</p>
1577
1677
  */
1578
1678
  Id?: string;
1579
1679
  /**
1680
+ * @public
1580
1681
  * <p>The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.</p>
1581
1682
  */
1582
1683
  Arn?: string;
1583
1684
  /**
1685
+ * @public
1584
1686
  * <p>The name of the namespace, such as <code>example.com</code>.</p>
1585
1687
  */
1586
1688
  Name?: string;
1587
1689
  /**
1690
+ * @public
1588
1691
  * <p>The type of the namespace. The methods for discovering instances depends on the value that
1589
1692
  * you specify:</p>
1590
1693
  * <dl>
@@ -1607,25 +1710,30 @@ export interface Namespace {
1607
1710
  */
1608
1711
  Type?: NamespaceType | string;
1609
1712
  /**
1713
+ * @public
1610
1714
  * <p>The description that you specify for the namespace when you create it.</p>
1611
1715
  */
1612
1716
  Description?: string;
1613
1717
  /**
1718
+ * @public
1614
1719
  * <p>The number of services that are associated with the namespace.</p>
1615
1720
  */
1616
1721
  ServiceCount?: number;
1617
1722
  /**
1723
+ * @public
1618
1724
  * <p>A complex type that contains information that's specific to the type of the
1619
1725
  * namespace.</p>
1620
1726
  */
1621
1727
  Properties?: NamespaceProperties;
1622
1728
  /**
1729
+ * @public
1623
1730
  * <p>The date that the namespace was created, in Unix date/time format and Coordinated Universal
1624
1731
  * Time (UTC). The value of <code>CreateDate</code> is accurate to milliseconds. For example, the
1625
1732
  * value <code>1516925490.087</code> represents Friday, January 26, 2018 12:11:30.087 AM.</p>
1626
1733
  */
1627
1734
  CreateDate?: Date;
1628
1735
  /**
1736
+ * @public
1629
1737
  * <p>A unique string that identifies the request and that allows failed requests to be retried
1630
1738
  * without the risk of running an operation twice. </p>
1631
1739
  */
@@ -1636,6 +1744,7 @@ export interface Namespace {
1636
1744
  */
1637
1745
  export interface GetNamespaceResponse {
1638
1746
  /**
1747
+ * @public
1639
1748
  * <p>A complex type that contains information about the specified namespace.</p>
1640
1749
  */
1641
1750
  Namespace?: Namespace;
@@ -1645,6 +1754,7 @@ export interface GetNamespaceResponse {
1645
1754
  */
1646
1755
  export interface GetOperationRequest {
1647
1756
  /**
1757
+ * @public
1648
1758
  * <p>The ID of the operation that you want to get more information about.</p>
1649
1759
  */
1650
1760
  OperationId: string | undefined;
@@ -1698,14 +1808,17 @@ export type OperationType = (typeof OperationType)[keyof typeof OperationType];
1698
1808
  */
1699
1809
  export interface Operation {
1700
1810
  /**
1811
+ * @public
1701
1812
  * <p>The ID of the operation that you want to get information about.</p>
1702
1813
  */
1703
1814
  Id?: string;
1704
1815
  /**
1816
+ * @public
1705
1817
  * <p>The name of the operation that's associated with the specified ID.</p>
1706
1818
  */
1707
1819
  Type?: OperationType | string;
1708
1820
  /**
1821
+ * @public
1709
1822
  * <p>The status of the operation. Values include the following:</p>
1710
1823
  * <dl>
1711
1824
  * <dt>SUBMITTED</dt>
@@ -1728,11 +1841,13 @@ export interface Operation {
1728
1841
  */
1729
1842
  Status?: OperationStatus | string;
1730
1843
  /**
1844
+ * @public
1731
1845
  * <p>If the value of <code>Status</code> is <code>FAIL</code>, the reason that the operation
1732
1846
  * failed.</p>
1733
1847
  */
1734
1848
  ErrorMessage?: string;
1735
1849
  /**
1850
+ * @public
1736
1851
  * <p>The code associated with <code>ErrorMessage</code>. Values for <code>ErrorCode</code>
1737
1852
  * include the following:</p>
1738
1853
  * <ul>
@@ -1775,6 +1890,7 @@ export interface Operation {
1775
1890
  */
1776
1891
  ErrorCode?: string;
1777
1892
  /**
1893
+ * @public
1778
1894
  * <p>The date and time that the request was submitted, in Unix date/time format and Coordinated
1779
1895
  * Universal Time (UTC). The value of <code>CreateDate</code> is accurate to milliseconds. For
1780
1896
  * example, the value <code>1516925490.087</code> represents Friday, January 26, 2018 12:11:30.087
@@ -1782,6 +1898,7 @@ export interface Operation {
1782
1898
  */
1783
1899
  CreateDate?: Date;
1784
1900
  /**
1901
+ * @public
1785
1902
  * <p>The date and time that the value of <code>Status</code> changed to the current value, in
1786
1903
  * Unix date/time format and Coordinated Universal Time (UTC). The value of <code>UpdateDate</code>
1787
1904
  * is accurate to milliseconds. For example, the value <code>1516925490.087</code> represents
@@ -1789,6 +1906,7 @@ export interface Operation {
1789
1906
  */
1790
1907
  UpdateDate?: Date;
1791
1908
  /**
1909
+ * @public
1792
1910
  * <p>The name of the target entity that's associated with the operation:</p>
1793
1911
  * <dl>
1794
1912
  * <dt>NAMESPACE</dt>
@@ -1812,6 +1930,7 @@ export interface Operation {
1812
1930
  */
1813
1931
  export interface GetOperationResponse {
1814
1932
  /**
1933
+ * @public
1815
1934
  * <p>A complex type that contains information about the operation.</p>
1816
1935
  */
1817
1936
  Operation?: Operation;
@@ -1834,6 +1953,7 @@ export declare class OperationNotFound extends __BaseException {
1834
1953
  */
1835
1954
  export interface GetServiceRequest {
1836
1955
  /**
1956
+ * @public
1837
1957
  * <p>The ID of the service that you want to get settings for.</p>
1838
1958
  */
1839
1959
  Id: string | undefined;
@@ -1843,6 +1963,7 @@ export interface GetServiceRequest {
1843
1963
  */
1844
1964
  export interface GetServiceResponse {
1845
1965
  /**
1966
+ * @public
1846
1967
  * <p>A complex type that contains information about the service.</p>
1847
1968
  */
1848
1969
  Service?: Service;
@@ -1854,6 +1975,7 @@ export interface GetServiceResponse {
1854
1975
  */
1855
1976
  export interface HttpNamespaceChange {
1856
1977
  /**
1978
+ * @public
1857
1979
  * <p>An updated
1858
1980
  * description for the HTTP namespace.</p>
1859
1981
  */
@@ -1866,10 +1988,12 @@ export interface HttpNamespaceChange {
1866
1988
  */
1867
1989
  export interface InstanceSummary {
1868
1990
  /**
1991
+ * @public
1869
1992
  * <p>The ID for an instance that you created by using a specified service.</p>
1870
1993
  */
1871
1994
  Id?: string;
1872
1995
  /**
1996
+ * @public
1873
1997
  * <p>A string map that contains the following information:</p>
1874
1998
  * <ul>
1875
1999
  * <li>
@@ -1929,10 +2053,12 @@ export interface InstanceSummary {
1929
2053
  */
1930
2054
  export interface ListInstancesRequest {
1931
2055
  /**
2056
+ * @public
1932
2057
  * <p>The ID of the service that you want to list instances for.</p>
1933
2058
  */
1934
2059
  ServiceId: string | undefined;
1935
2060
  /**
2061
+ * @public
1936
2062
  * <p>For the first <code>ListInstances</code> request, omit this value.</p>
1937
2063
  * <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit
1938
2064
  * another <code>ListInstances</code> request to get the next group of results. Specify the value of
@@ -1940,6 +2066,7 @@ export interface ListInstancesRequest {
1940
2066
  */
1941
2067
  NextToken?: string;
1942
2068
  /**
2069
+ * @public
1943
2070
  * <p>The maximum number of instances that you want Cloud Map to return in the response to a
1944
2071
  * <code>ListInstances</code> request. If you don't specify a value for <code>MaxResults</code>,
1945
2072
  * Cloud Map returns up to 100 instances.</p>
@@ -1951,11 +2078,13 @@ export interface ListInstancesRequest {
1951
2078
  */
1952
2079
  export interface ListInstancesResponse {
1953
2080
  /**
2081
+ * @public
1954
2082
  * <p>Summary information about the instances that are associated with the specified
1955
2083
  * service.</p>
1956
2084
  */
1957
2085
  Instances?: InstanceSummary[];
1958
2086
  /**
2087
+ * @public
1959
2088
  * <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit
1960
2089
  * another <code>ListInstances</code> request to get the next group of results. Specify the value of
1961
2090
  * <code>NextToken</code> from the previous response in the next request.</p>
@@ -1982,6 +2111,7 @@ export type NamespaceFilterName = (typeof NamespaceFilterName)[keyof typeof Name
1982
2111
  */
1983
2112
  export interface NamespaceFilter {
1984
2113
  /**
2114
+ * @public
1985
2115
  * <p>Specify the namespaces that you want to get using one of the following.</p>
1986
2116
  * <ul>
1987
2117
  * <li>
@@ -2000,6 +2130,7 @@ export interface NamespaceFilter {
2000
2130
  */
2001
2131
  Name: NamespaceFilterName | string | undefined;
2002
2132
  /**
2133
+ * @public
2003
2134
  * <p>Specify the values that are applicable to the value that you specify for
2004
2135
  * <code>Name</code>.</p>
2005
2136
  * <ul>
@@ -2022,6 +2153,7 @@ export interface NamespaceFilter {
2022
2153
  */
2023
2154
  Values: string[] | undefined;
2024
2155
  /**
2156
+ * @public
2025
2157
  * <p>Specify the operator that you want to use to determine whether a namespace matches the
2026
2158
  * specified value. Valid values for <code>Condition</code> are one of the following.</p>
2027
2159
  * <ul>
@@ -2047,6 +2179,7 @@ export interface NamespaceFilter {
2047
2179
  */
2048
2180
  export interface ListNamespacesRequest {
2049
2181
  /**
2182
+ * @public
2050
2183
  * <p>For the first <code>ListNamespaces</code> request, omit this value.</p>
2051
2184
  * <p>If the response contains <code>NextToken</code>, submit another <code>ListNamespaces</code>
2052
2185
  * request to get the next group of results. Specify the value of <code>NextToken</code> from the
@@ -2060,12 +2193,14 @@ export interface ListNamespacesRequest {
2060
2193
  */
2061
2194
  NextToken?: string;
2062
2195
  /**
2196
+ * @public
2063
2197
  * <p>The maximum number of namespaces that you want Cloud Map to return in the response to a
2064
2198
  * <code>ListNamespaces</code> request. If you don't specify a value for <code>MaxResults</code>,
2065
2199
  * Cloud Map returns up to 100 namespaces.</p>
2066
2200
  */
2067
2201
  MaxResults?: number;
2068
2202
  /**
2203
+ * @public
2069
2204
  * <p>A complex type that contains specifications for the namespaces that you want to list.</p>
2070
2205
  * <p>If you specify more than one filter, a namespace must match all filters to be returned by
2071
2206
  * <code>ListNamespaces</code>.</p>
@@ -2078,35 +2213,43 @@ export interface ListNamespacesRequest {
2078
2213
  */
2079
2214
  export interface NamespaceSummary {
2080
2215
  /**
2216
+ * @public
2081
2217
  * <p>The ID of the namespace.</p>
2082
2218
  */
2083
2219
  Id?: string;
2084
2220
  /**
2221
+ * @public
2085
2222
  * <p>The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.</p>
2086
2223
  */
2087
2224
  Arn?: string;
2088
2225
  /**
2226
+ * @public
2089
2227
  * <p>The name of the namespace. When you create a namespace, Cloud Map automatically creates a
2090
2228
  * Route 53 hosted zone that has the same name as the namespace.</p>
2091
2229
  */
2092
2230
  Name?: string;
2093
2231
  /**
2232
+ * @public
2094
2233
  * <p>The type of the namespace, either public or private.</p>
2095
2234
  */
2096
2235
  Type?: NamespaceType | string;
2097
2236
  /**
2237
+ * @public
2098
2238
  * <p>A description for the namespace.</p>
2099
2239
  */
2100
2240
  Description?: string;
2101
2241
  /**
2242
+ * @public
2102
2243
  * <p>The number of services that were created using the namespace.</p>
2103
2244
  */
2104
2245
  ServiceCount?: number;
2105
2246
  /**
2247
+ * @public
2106
2248
  * <p>The properties of the namespace.</p>
2107
2249
  */
2108
2250
  Properties?: NamespaceProperties;
2109
2251
  /**
2252
+ * @public
2110
2253
  * <p>The date and time that the namespace was created.</p>
2111
2254
  */
2112
2255
  CreateDate?: Date;
@@ -2116,11 +2259,13 @@ export interface NamespaceSummary {
2116
2259
  */
2117
2260
  export interface ListNamespacesResponse {
2118
2261
  /**
2262
+ * @public
2119
2263
  * <p>An array that contains one <code>NamespaceSummary</code> object for each namespace that
2120
2264
  * matches the specified filter criteria.</p>
2121
2265
  */
2122
2266
  Namespaces?: NamespaceSummary[];
2123
2267
  /**
2268
+ * @public
2124
2269
  * <p>If the response contains <code>NextToken</code>, submit another <code>ListNamespaces</code>
2125
2270
  * request to get the next group of results. Specify the value of <code>NextToken</code> from the
2126
2271
  * previous response in the next request.</p>
@@ -2154,6 +2299,7 @@ export type OperationFilterName = (typeof OperationFilterName)[keyof typeof Oper
2154
2299
  */
2155
2300
  export interface OperationFilter {
2156
2301
  /**
2302
+ * @public
2157
2303
  * <p>Specify the operations that you want to get:</p>
2158
2304
  * <ul>
2159
2305
  * <li>
@@ -2185,6 +2331,7 @@ export interface OperationFilter {
2185
2331
  */
2186
2332
  Name: OperationFilterName | string | undefined;
2187
2333
  /**
2334
+ * @public
2188
2335
  * <p>Specify values that are applicable to the value that you specify for <code>Name</code>: </p>
2189
2336
  * <ul>
2190
2337
  * <li>
@@ -2217,6 +2364,7 @@ export interface OperationFilter {
2217
2364
  */
2218
2365
  Values: string[] | undefined;
2219
2366
  /**
2367
+ * @public
2220
2368
  * <p>The operator that you want to use to determine whether an operation matches the specified
2221
2369
  * value. Valid values for condition include:</p>
2222
2370
  * <ul>
@@ -2249,6 +2397,7 @@ export interface OperationFilter {
2249
2397
  */
2250
2398
  export interface ListOperationsRequest {
2251
2399
  /**
2400
+ * @public
2252
2401
  * <p>For the first <code>ListOperations</code> request, omit this value.</p>
2253
2402
  * <p>If the response contains <code>NextToken</code>, submit another <code>ListOperations</code>
2254
2403
  * request to get the next group of results. Specify the value of <code>NextToken</code> from the
@@ -2262,12 +2411,14 @@ export interface ListOperationsRequest {
2262
2411
  */
2263
2412
  NextToken?: string;
2264
2413
  /**
2414
+ * @public
2265
2415
  * <p>The maximum number of items that you want Cloud Map to return in the response to a
2266
2416
  * <code>ListOperations</code> request. If you don't specify a value for <code>MaxResults</code>,
2267
2417
  * Cloud Map returns up to 100 operations.</p>
2268
2418
  */
2269
2419
  MaxResults?: number;
2270
2420
  /**
2421
+ * @public
2271
2422
  * <p>A complex type that contains specifications for the operations that you want to list, for
2272
2423
  * example, operations that you started between a specified start date and end date.</p>
2273
2424
  * <p>If you specify more than one filter, an operation must match all filters to be returned by
@@ -2282,10 +2433,12 @@ export interface ListOperationsRequest {
2282
2433
  */
2283
2434
  export interface OperationSummary {
2284
2435
  /**
2436
+ * @public
2285
2437
  * <p>The ID for an operation.</p>
2286
2438
  */
2287
2439
  Id?: string;
2288
2440
  /**
2441
+ * @public
2289
2442
  * <p>The status of the operation. Values include the following:</p>
2290
2443
  * <ul>
2291
2444
  * <li>
@@ -2315,10 +2468,12 @@ export interface OperationSummary {
2315
2468
  */
2316
2469
  export interface ListOperationsResponse {
2317
2470
  /**
2471
+ * @public
2318
2472
  * <p>Summary information about the operations that match the specified criteria.</p>
2319
2473
  */
2320
2474
  Operations?: OperationSummary[];
2321
2475
  /**
2476
+ * @public
2322
2477
  * <p>If the response contains <code>NextToken</code>, submit another <code>ListOperations</code>
2323
2478
  * request to get the next group of results. Specify the value of <code>NextToken</code> from the
2324
2479
  * previous response in the next request.</p>
@@ -2349,15 +2504,18 @@ export type ServiceFilterName = (typeof ServiceFilterName)[keyof typeof ServiceF
2349
2504
  */
2350
2505
  export interface ServiceFilter {
2351
2506
  /**
2507
+ * @public
2352
2508
  * <p>Specify <code>NAMESPACE_ID</code>.</p>
2353
2509
  */
2354
2510
  Name: ServiceFilterName | string | undefined;
2355
2511
  /**
2512
+ * @public
2356
2513
  * <p>The values that are applicable to the value that you specify for <code>Condition</code> to
2357
2514
  * filter the list of services.</p>
2358
2515
  */
2359
2516
  Values: string[] | undefined;
2360
2517
  /**
2518
+ * @public
2361
2519
  * <p>The operator that you want to use to determine whether a service is returned by
2362
2520
  * <code>ListServices</code>. Valid values for <code>Condition</code> include the following:</p>
2363
2521
  * <ul>
@@ -2375,6 +2533,7 @@ export interface ServiceFilter {
2375
2533
  */
2376
2534
  export interface ListServicesRequest {
2377
2535
  /**
2536
+ * @public
2378
2537
  * <p>For the first <code>ListServices</code> request, omit this value.</p>
2379
2538
  * <p>If the response contains <code>NextToken</code>, submit another <code>ListServices</code>
2380
2539
  * request to get the next group of results. Specify the value of <code>NextToken</code> from the
@@ -2388,12 +2547,14 @@ export interface ListServicesRequest {
2388
2547
  */
2389
2548
  NextToken?: string;
2390
2549
  /**
2550
+ * @public
2391
2551
  * <p>The maximum number of services that you want Cloud Map to return in the response to a
2392
2552
  * <code>ListServices</code> request. If you don't specify a value for <code>MaxResults</code>,
2393
2553
  * Cloud Map returns up to 100 services.</p>
2394
2554
  */
2395
2555
  MaxResults?: number;
2396
2556
  /**
2557
+ * @public
2397
2558
  * <p>A complex type that contains specifications for the namespaces that you want to list
2398
2559
  * services for. </p>
2399
2560
  * <p>If you specify more than one filter, an operation must match all filters to be returned by
@@ -2407,18 +2568,22 @@ export interface ListServicesRequest {
2407
2568
  */
2408
2569
  export interface ServiceSummary {
2409
2570
  /**
2571
+ * @public
2410
2572
  * <p>The ID that Cloud Map assigned to the service when you created it.</p>
2411
2573
  */
2412
2574
  Id?: string;
2413
2575
  /**
2576
+ * @public
2414
2577
  * <p>The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.</p>
2415
2578
  */
2416
2579
  Arn?: string;
2417
2580
  /**
2581
+ * @public
2418
2582
  * <p>The name of the service.</p>
2419
2583
  */
2420
2584
  Name?: string;
2421
2585
  /**
2586
+ * @public
2422
2587
  * <p>Describes the systems that can be used to discover the service instances.</p>
2423
2588
  * <dl>
2424
2589
  * <dt>DNS_HTTP</dt>
@@ -2439,21 +2604,25 @@ export interface ServiceSummary {
2439
2604
  */
2440
2605
  Type?: ServiceType | string;
2441
2606
  /**
2607
+ * @public
2442
2608
  * <p>The description that you specify when you create the service.</p>
2443
2609
  */
2444
2610
  Description?: string;
2445
2611
  /**
2612
+ * @public
2446
2613
  * <p>The number of instances that are currently associated with the service. Instances that were
2447
2614
  * previously associated with the service but that are deleted aren't included in the count. The
2448
2615
  * count might not reflect pending registrations and deregistrations.</p>
2449
2616
  */
2450
2617
  InstanceCount?: number;
2451
2618
  /**
2619
+ * @public
2452
2620
  * <p>Information about the Route 53 DNS records that you want Cloud Map to create when you register
2453
2621
  * an instance.</p>
2454
2622
  */
2455
2623
  DnsConfig?: DnsConfig;
2456
2624
  /**
2625
+ * @public
2457
2626
  * <p>
2458
2627
  * <i>Public DNS and HTTP namespaces only.</i> Settings for an optional health
2459
2628
  * check. If you specify settings for a health check, Cloud Map associates the health check with
@@ -2461,6 +2630,7 @@ export interface ServiceSummary {
2461
2630
  */
2462
2631
  HealthCheckConfig?: HealthCheckConfig;
2463
2632
  /**
2633
+ * @public
2464
2634
  * <p>Information about an optional custom health check. A custom health check, which requires
2465
2635
  * that you use a third-party health checker to evaluate the health of your resources, is useful in
2466
2636
  * the following circumstances:</p>
@@ -2483,6 +2653,7 @@ export interface ServiceSummary {
2483
2653
  */
2484
2654
  HealthCheckCustomConfig?: HealthCheckCustomConfig;
2485
2655
  /**
2656
+ * @public
2486
2657
  * <p>The date and time that the service was created.</p>
2487
2658
  */
2488
2659
  CreateDate?: Date;
@@ -2492,11 +2663,13 @@ export interface ServiceSummary {
2492
2663
  */
2493
2664
  export interface ListServicesResponse {
2494
2665
  /**
2666
+ * @public
2495
2667
  * <p>An array that contains one <code>ServiceSummary</code> object for each service that matches
2496
2668
  * the specified filter criteria.</p>
2497
2669
  */
2498
2670
  Services?: ServiceSummary[];
2499
2671
  /**
2672
+ * @public
2500
2673
  * <p>If the response contains <code>NextToken</code>, submit another <code>ListServices</code>
2501
2674
  * request to get the next group of results. Specify the value of <code>NextToken</code> from the
2502
2675
  * previous response in the next request.</p>
@@ -2514,6 +2687,7 @@ export interface ListServicesResponse {
2514
2687
  */
2515
2688
  export interface ListTagsForResourceRequest {
2516
2689
  /**
2690
+ * @public
2517
2691
  * <p>The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for.</p>
2518
2692
  */
2519
2693
  ResourceARN: string | undefined;
@@ -2523,6 +2697,7 @@ export interface ListTagsForResourceRequest {
2523
2697
  */
2524
2698
  export interface ListTagsForResourceResponse {
2525
2699
  /**
2700
+ * @public
2526
2701
  * <p>The tags that are assigned to the resource.</p>
2527
2702
  */
2528
2703
  Tags?: Tag[];
@@ -2547,6 +2722,7 @@ export declare class ResourceNotFoundException extends __BaseException {
2547
2722
  */
2548
2723
  export interface SOAChange {
2549
2724
  /**
2725
+ * @public
2550
2726
  * <p>The updated time to
2551
2727
  * live (TTL) for purposes of negative caching.</p>
2552
2728
  */
@@ -2559,6 +2735,7 @@ export interface SOAChange {
2559
2735
  */
2560
2736
  export interface PrivateDnsPropertiesMutableChange {
2561
2737
  /**
2738
+ * @public
2562
2739
  * <p>Updated fields for
2563
2740
  * the Start of Authority (SOA) record for the hosted zone for the private DNS
2564
2741
  * namespace.</p>
@@ -2572,6 +2749,7 @@ export interface PrivateDnsPropertiesMutableChange {
2572
2749
  */
2573
2750
  export interface PrivateDnsNamespacePropertiesChange {
2574
2751
  /**
2752
+ * @public
2575
2753
  * <p>Updated DNS
2576
2754
  * properties for the private DNS namespace.</p>
2577
2755
  */
@@ -2584,11 +2762,13 @@ export interface PrivateDnsNamespacePropertiesChange {
2584
2762
  */
2585
2763
  export interface PrivateDnsNamespaceChange {
2586
2764
  /**
2765
+ * @public
2587
2766
  * <p>An updated
2588
2767
  * description for the private DNS namespace.</p>
2589
2768
  */
2590
2769
  Description?: string;
2591
2770
  /**
2771
+ * @public
2592
2772
  * <p>Properties to be
2593
2773
  * updated in the private DNS namespace.</p>
2594
2774
  */
@@ -2601,6 +2781,7 @@ export interface PrivateDnsNamespaceChange {
2601
2781
  */
2602
2782
  export interface PublicDnsPropertiesMutableChange {
2603
2783
  /**
2784
+ * @public
2604
2785
  * <p>Updated fields for
2605
2786
  * the Start of Authority (SOA) record for the hosted zone for the public DNS
2606
2787
  * namespace.</p>
@@ -2614,6 +2795,7 @@ export interface PublicDnsPropertiesMutableChange {
2614
2795
  */
2615
2796
  export interface PublicDnsNamespacePropertiesChange {
2616
2797
  /**
2798
+ * @public
2617
2799
  * <p>Updated DNS
2618
2800
  * properties for the hosted zone for the public DNS namespace.</p>
2619
2801
  */
@@ -2626,11 +2808,13 @@ export interface PublicDnsNamespacePropertiesChange {
2626
2808
  */
2627
2809
  export interface PublicDnsNamespaceChange {
2628
2810
  /**
2811
+ * @public
2629
2812
  * <p>An updated
2630
2813
  * description for the public DNS namespace.</p>
2631
2814
  */
2632
2815
  Description?: string;
2633
2816
  /**
2817
+ * @public
2634
2818
  * <p>Properties to be
2635
2819
  * updated in the public DNS namespace.</p>
2636
2820
  */
@@ -2641,10 +2825,12 @@ export interface PublicDnsNamespaceChange {
2641
2825
  */
2642
2826
  export interface RegisterInstanceRequest {
2643
2827
  /**
2828
+ * @public
2644
2829
  * <p>The ID of the service that you want to use for settings for the instance.</p>
2645
2830
  */
2646
2831
  ServiceId: string | undefined;
2647
2832
  /**
2833
+ * @public
2648
2834
  * <p>An identifier that you want to associate with the instance. Note the following:</p>
2649
2835
  * <ul>
2650
2836
  * <li>
@@ -2678,6 +2864,7 @@ export interface RegisterInstanceRequest {
2678
2864
  */
2679
2865
  InstanceId: string | undefined;
2680
2866
  /**
2867
+ * @public
2681
2868
  * <p>A unique string that identifies the request and that allows failed
2682
2869
  * <code>RegisterInstance</code> requests to be retried without the risk of executing the operation
2683
2870
  * twice. You must use a unique <code>CreatorRequestId</code> string every time you submit a
@@ -2687,6 +2874,7 @@ export interface RegisterInstanceRequest {
2687
2874
  */
2688
2875
  CreatorRequestId?: string;
2689
2876
  /**
2877
+ * @public
2690
2878
  * <p>A string map that contains the following information for the service that you specify in
2691
2879
  * <code>ServiceId</code>:</p>
2692
2880
  * <ul>
@@ -2802,6 +2990,7 @@ export interface RegisterInstanceRequest {
2802
2990
  */
2803
2991
  export interface RegisterInstanceResponse {
2804
2992
  /**
2993
+ * @public
2805
2994
  * <p>A value that you can use to determine whether the request completed successfully.
2806
2995
  * 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>
2807
2996
  */
@@ -2812,10 +3001,12 @@ export interface RegisterInstanceResponse {
2812
3001
  */
2813
3002
  export interface TagResourceRequest {
2814
3003
  /**
3004
+ * @public
2815
3005
  * <p>The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for.</p>
2816
3006
  */
2817
3007
  ResourceARN: string | undefined;
2818
3008
  /**
3009
+ * @public
2819
3010
  * <p>The tags to add to the specified resource. Specifying the tag key is required. You can set
2820
3011
  * the value of a tag to an empty string, but you can't set the value of a tag to null.</p>
2821
3012
  */
@@ -2831,10 +3022,12 @@ export interface TagResourceResponse {
2831
3022
  */
2832
3023
  export interface UntagResourceRequest {
2833
3024
  /**
3025
+ * @public
2834
3026
  * <p>The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for.</p>
2835
3027
  */
2836
3028
  ResourceARN: string | undefined;
2837
3029
  /**
3030
+ * @public
2838
3031
  * <p>The tag keys to remove from the specified resource.</p>
2839
3032
  */
2840
3033
  TagKeys: string[] | undefined;
@@ -2849,11 +3042,13 @@ export interface UntagResourceResponse {
2849
3042
  */
2850
3043
  export interface UpdateHttpNamespaceRequest {
2851
3044
  /**
3045
+ * @public
2852
3046
  * <p>The ID of the
2853
3047
  * namespace that you want to update.</p>
2854
3048
  */
2855
3049
  Id: string | undefined;
2856
3050
  /**
3051
+ * @public
2857
3052
  * <p>A unique string that
2858
3053
  * identifies the request and that allows failed <code>UpdateHttpNamespace</code> requests to be
2859
3054
  * retried without the risk of running the operation twice. <code>UpdaterRequestId</code> can be any
@@ -2861,6 +3056,7 @@ export interface UpdateHttpNamespaceRequest {
2861
3056
  */
2862
3057
  UpdaterRequestId?: string;
2863
3058
  /**
3059
+ * @public
2864
3060
  * <p>Updated properties
2865
3061
  * for the the HTTP namespace.</p>
2866
3062
  */
@@ -2871,6 +3067,7 @@ export interface UpdateHttpNamespaceRequest {
2871
3067
  */
2872
3068
  export interface UpdateHttpNamespaceResponse {
2873
3069
  /**
3070
+ * @public
2874
3071
  * <p>A value that you can use to determine whether the request completed successfully.
2875
3072
  * 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>
2876
3073
  */
@@ -2881,15 +3078,18 @@ export interface UpdateHttpNamespaceResponse {
2881
3078
  */
2882
3079
  export interface UpdateInstanceCustomHealthStatusRequest {
2883
3080
  /**
3081
+ * @public
2884
3082
  * <p>The ID of the service that includes the configuration for the custom health check that you
2885
3083
  * want to change the status for.</p>
2886
3084
  */
2887
3085
  ServiceId: string | undefined;
2888
3086
  /**
3087
+ * @public
2889
3088
  * <p>The ID of the instance that you want to change the health status for.</p>
2890
3089
  */
2891
3090
  InstanceId: string | undefined;
2892
3091
  /**
3092
+ * @public
2893
3093
  * <p>The new status of the instance, <code>HEALTHY</code> or <code>UNHEALTHY</code>.</p>
2894
3094
  */
2895
3095
  Status: CustomHealthStatus | string | undefined;
@@ -2899,11 +3099,13 @@ export interface UpdateInstanceCustomHealthStatusRequest {
2899
3099
  */
2900
3100
  export interface UpdatePrivateDnsNamespaceRequest {
2901
3101
  /**
3102
+ * @public
2902
3103
  * <p>The ID of the
2903
3104
  * namespace that you want to update.</p>
2904
3105
  */
2905
3106
  Id: string | undefined;
2906
3107
  /**
3108
+ * @public
2907
3109
  * <p>A unique string that
2908
3110
  * identifies the request and that allows failed <code>UpdatePrivateDnsNamespace</code> requests to
2909
3111
  * be retried without the risk of running the operation twice. <code>UpdaterRequestId</code> can be
@@ -2911,6 +3113,7 @@ export interface UpdatePrivateDnsNamespaceRequest {
2911
3113
  */
2912
3114
  UpdaterRequestId?: string;
2913
3115
  /**
3116
+ * @public
2914
3117
  * <p>Updated properties
2915
3118
  * for the private DNS namespace.</p>
2916
3119
  */
@@ -2921,6 +3124,7 @@ export interface UpdatePrivateDnsNamespaceRequest {
2921
3124
  */
2922
3125
  export interface UpdatePrivateDnsNamespaceResponse {
2923
3126
  /**
3127
+ * @public
2924
3128
  * <p>A value that you can use to determine whether the request completed successfully.
2925
3129
  * 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>
2926
3130
  */
@@ -2931,11 +3135,13 @@ export interface UpdatePrivateDnsNamespaceResponse {
2931
3135
  */
2932
3136
  export interface UpdatePublicDnsNamespaceRequest {
2933
3137
  /**
3138
+ * @public
2934
3139
  * <p>The ID of the
2935
3140
  * namespace being updated.</p>
2936
3141
  */
2937
3142
  Id: string | undefined;
2938
3143
  /**
3144
+ * @public
2939
3145
  * <p>A unique string that
2940
3146
  * identifies the request and that allows failed <code>UpdatePublicDnsNamespace</code> requests to
2941
3147
  * be retried without the risk of running the operation twice. <code>UpdaterRequestId</code> can be
@@ -2943,6 +3149,7 @@ export interface UpdatePublicDnsNamespaceRequest {
2943
3149
  */
2944
3150
  UpdaterRequestId?: string;
2945
3151
  /**
3152
+ * @public
2946
3153
  * <p>Updated properties
2947
3154
  * for the public DNS namespace.</p>
2948
3155
  */
@@ -2953,6 +3160,7 @@ export interface UpdatePublicDnsNamespaceRequest {
2953
3160
  */
2954
3161
  export interface UpdatePublicDnsNamespaceResponse {
2955
3162
  /**
3163
+ * @public
2956
3164
  * <p>A value that you can use to determine whether the request completed successfully.
2957
3165
  * 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>
2958
3166
  */
@@ -2964,15 +3172,18 @@ export interface UpdatePublicDnsNamespaceResponse {
2964
3172
  */
2965
3173
  export interface ServiceChange {
2966
3174
  /**
3175
+ * @public
2967
3176
  * <p>A description for the service.</p>
2968
3177
  */
2969
3178
  Description?: string;
2970
3179
  /**
3180
+ * @public
2971
3181
  * <p>Information about the Route 53 DNS records that you want Cloud Map to create when you register
2972
3182
  * an instance.</p>
2973
3183
  */
2974
3184
  DnsConfig?: DnsConfigChange;
2975
3185
  /**
3186
+ * @public
2976
3187
  * <p>
2977
3188
  * <i>Public DNS and HTTP namespaces only.</i> Settings for an optional health
2978
3189
  * check. If you specify settings for a health check, Cloud Map associates the health check with
@@ -2985,10 +3196,12 @@ export interface ServiceChange {
2985
3196
  */
2986
3197
  export interface UpdateServiceRequest {
2987
3198
  /**
3199
+ * @public
2988
3200
  * <p>The ID of the service that you want to update.</p>
2989
3201
  */
2990
3202
  Id: string | undefined;
2991
3203
  /**
3204
+ * @public
2992
3205
  * <p>A complex type that contains the new settings for the service.</p>
2993
3206
  */
2994
3207
  Service: ServiceChange | undefined;
@@ -2998,6 +3211,7 @@ export interface UpdateServiceRequest {
2998
3211
  */
2999
3212
  export interface UpdateServiceResponse {
3000
3213
  /**
3214
+ * @public
3001
3215
  * <p>A value that you can use to determine whether the request completed successfully.
3002
3216
  * 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>
3003
3217
  */