@aws-sdk/client-servicediscovery 3.873.0 → 3.876.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.
@@ -198,6 +198,7 @@ declare const CreateServiceCommand_base: {
198
198
  * Service: {
199
199
  * Arn: "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita",
200
200
  * CreateDate: 1.587081768334E9,
201
+ * CreatedByAccount: "123456789012",
201
202
  * CreatorRequestId: "567c1193-6b00-4308-bd57-ad38a8822d25",
202
203
  * DnsConfig: {
203
204
  * DnsRecords: [
@@ -210,8 +211,59 @@ declare const CreateServiceCommand_base: {
210
211
  * RoutingPolicy: "MULTIVALUE"
211
212
  * },
212
213
  * Id: "srv-p5zdwlg5uvvzjita",
214
+ * InstanceCount: 0,
213
215
  * Name: "myservice",
214
- * NamespaceId: "ns-ylexjili4cdxy3xm"
216
+ * NamespaceId: "ns-ylexjili4cdxy3xm",
217
+ * ResourceOwner: "123456789012",
218
+ * Type: "DNS_HTTP"
219
+ * }
220
+ * }
221
+ * *\/
222
+ * ```
223
+ *
224
+ * @example Create service using namespace ARN
225
+ * ```javascript
226
+ * // Namespace sharee creates a service using a namespace ARN instead of namespace ID, useful when working with shared namespaces.
227
+ * const input = {
228
+ * Description: "Example service using namespace ARN",
229
+ * DnsConfig: {
230
+ * DnsRecords: [
231
+ * {
232
+ * TTL: 300,
233
+ * Type: "A"
234
+ * }
235
+ * ],
236
+ * RoutingPolicy: "MULTIVALUE"
237
+ * },
238
+ * Name: "example-service",
239
+ * NamespaceId: "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-abcd1234xmpl5678"
240
+ * };
241
+ * const command = new CreateServiceCommand(input);
242
+ * const response = await client.send(command);
243
+ * /* response is
244
+ * {
245
+ * Service: {
246
+ * Arn: "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678",
247
+ * CreateDate: 1.7051616E9,
248
+ * CreatedByAccount: "111122223333",
249
+ * CreatorRequestId: "abcd1234-xmpl-5678-9012-abcd1234xmpl",
250
+ * Description: "Example service using namespace ARN",
251
+ * DnsConfig: {
252
+ * DnsRecords: [
253
+ * {
254
+ * TTL: 300,
255
+ * Type: "A"
256
+ * }
257
+ * ],
258
+ * NamespaceId: "ns-abcd1234xmpl5678",
259
+ * RoutingPolicy: "MULTIVALUE"
260
+ * },
261
+ * Id: "srv-abcd1234xmpl5678",
262
+ * InstanceCount: 0,
263
+ * Name: "example-service",
264
+ * NamespaceId: "ns-abcd1234xmpl5678",
265
+ * ResourceOwner: "123456789012",
266
+ * Type: "DNS_HTTP"
215
267
  * }
216
268
  * }
217
269
  * *\/
@@ -81,7 +81,22 @@ declare const DeleteNamespaceCommand_base: {
81
81
  * const response = await client.send(command);
82
82
  * /* response is
83
83
  * {
84
- * OperationId: "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k98y6drk"
84
+ * OperationId: "abcd1234-xmpl-5678-9012-abcd1234xmplabcd"
85
+ * }
86
+ * *\/
87
+ * ```
88
+ *
89
+ * @example Delete namespace using namespace ARN
90
+ * ```javascript
91
+ * // Deletes a namespace using a namespace ARN instead of namespace ID, useful when working with shared namespaces.
92
+ * const input = {
93
+ * Id: "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-abcd1234xmpl5678"
94
+ * };
95
+ * const command = new DeleteNamespaceCommand(input);
96
+ * const response = await client.send(command);
97
+ * /* response is
98
+ * {
99
+ * OperationId: "abcd1234-xmpl-5678-9012-abcd1234xmplabcd"
85
100
  * }
86
101
  * *\/
87
102
  * ```
@@ -80,6 +80,22 @@ declare const DeleteServiceAttributesCommand_base: {
80
80
  * *\/
81
81
  * ```
82
82
  *
83
+ * @example Delete service attributes using service ARN
84
+ * ```javascript
85
+ * // Deletes service attributes using a service ARN instead of service ID, useful for cross-account scenarios or when working with shared namespaces.
86
+ * const input = {
87
+ * Attributes: [
88
+ * "Port"
89
+ * ],
90
+ * ServiceId: "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678"
91
+ * };
92
+ * const command = new DeleteServiceAttributesCommand(input);
93
+ * const response = await client.send(command);
94
+ * /* response is
95
+ * { /* empty *\/ }
96
+ * *\/
97
+ * ```
98
+ *
83
99
  * @public
84
100
  */
85
101
  export declare class DeleteServiceAttributesCommand extends DeleteServiceAttributesCommand_base {
@@ -79,6 +79,19 @@ declare const DeleteServiceCommand_base: {
79
79
  * *\/
80
80
  * ```
81
81
  *
82
+ * @example Delete service using service ARN
83
+ * ```javascript
84
+ * // Deletes a service using a service ARN instead of service ID, useful when working with shared namespaces.
85
+ * const input = {
86
+ * Id: "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678"
87
+ * };
88
+ * const command = new DeleteServiceCommand(input);
89
+ * const response = await client.send(command);
90
+ * /* response is
91
+ * { /* empty *\/ }
92
+ * *\/
93
+ * ```
94
+ *
82
95
  * @public
83
96
  */
84
97
  export declare class DeleteServiceCommand extends DeleteServiceCommand_base {
@@ -92,6 +92,22 @@ declare const DeregisterInstanceCommand_base: {
92
92
  * *\/
93
93
  * ```
94
94
  *
95
+ * @example Deregister instance using service ARN
96
+ * ```javascript
97
+ * // Deregisters an instance using a service ARN instead of service ID, useful when working with shared namespaces.
98
+ * const input = {
99
+ * InstanceId: "i-abcd1234xmpl5678",
100
+ * ServiceId: "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678"
101
+ * };
102
+ * const command = new DeregisterInstanceCommand(input);
103
+ * const response = await client.send(command);
104
+ * /* response is
105
+ * {
106
+ * OperationId: "abcd1234-xmpl-5678-9012-abcd1234xmpl"
107
+ * }
108
+ * *\/
109
+ * ```
110
+ *
95
111
  * @public
96
112
  */
97
113
  export declare class DeregisterInstanceCommand extends DeregisterInstanceCommand_base {
@@ -96,6 +96,44 @@ declare const DiscoverInstancesCommand_base: {
96
96
  * <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>
97
97
  *
98
98
  *
99
+ * @example Discover instances using owner account
100
+ * ```javascript
101
+ * // Discovers instances in a shared namespace by specifying the OwnerAccount parameter, useful when working with shared namespaces.
102
+ * const input = {
103
+ * NamespaceName: "example-shared-namespace",
104
+ * OwnerAccount: "123456789012",
105
+ * ServiceName: "shared-namespace-service"
106
+ * };
107
+ * const command = new DiscoverInstancesCommand(input);
108
+ * const response = await client.send(command);
109
+ * /* response is
110
+ * {
111
+ * Instances: [
112
+ * {
113
+ * Attributes: {
114
+ * AWS_INSTANCE_IPV4: "192.0.2.44",
115
+ * AWS_INSTANCE_PORT: "80"
116
+ * },
117
+ * HealthStatus: "HEALTHY",
118
+ * InstanceId: "i-abcd1234xmpl5678",
119
+ * NamespaceName: "example-shared-namespace",
120
+ * ServiceName: "shared-service"
121
+ * },
122
+ * {
123
+ * Attributes: {
124
+ * AWS_INSTANCE_IPV4: "192.0.2.45",
125
+ * AWS_INSTANCE_PORT: "80"
126
+ * },
127
+ * HealthStatus: "HEALTHY",
128
+ * InstanceId: "i-efgh5678xmpl9012",
129
+ * NamespaceName: "example-shared-namespace",
130
+ * ServiceName: "shared-service"
131
+ * }
132
+ * ]
133
+ * }
134
+ * *\/
135
+ * ```
136
+ *
99
137
  * @example Example: Discover registered instances
100
138
  * ```javascript
101
139
  * // Example: Discover registered instances
@@ -73,6 +73,23 @@ declare const DiscoverInstancesRevisionCommand_base: {
73
73
  * <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>
74
74
  *
75
75
  *
76
+ * @example Discover instances revision using owner account
77
+ * ```javascript
78
+ * // Discovers the instances revision in a shared namespace by specifying the OwnerAccount parameter, useful when working with shared namespaces.
79
+ * const input = {
80
+ * NamespaceName: "example-shared-namespace",
81
+ * OwnerAccount: "123456789012",
82
+ * ServiceName: "shared-service"
83
+ * };
84
+ * const command = new DiscoverInstancesRevisionCommand(input);
85
+ * const response = await client.send(command);
86
+ * /* response is
87
+ * {
88
+ * InstancesRevision: 1001
89
+ * }
90
+ * *\/
91
+ * ```
92
+ *
76
93
  * @example To discover the revision for a registered instance
77
94
  * ```javascript
78
95
  * // The following example discovers the revision ID for a registered instance.
@@ -95,8 +95,37 @@ declare const GetInstanceCommand_base: {
95
95
  * region: "us-west-2",
96
96
  * stage: "beta"
97
97
  * },
98
+ * CreatedByAccount: "123456789012",
98
99
  * Id: "i-abcd1234"
99
- * }
100
+ * },
101
+ * ResourceOwner: "123456789012"
102
+ * }
103
+ * *\/
104
+ * ```
105
+ *
106
+ * @example Get instance details using service ARN for shared namespace
107
+ * ```javascript
108
+ * // This example gets information about an instance using a service ARN instead of service ID. This is useful for listing instances associated with shared namespaces.
109
+ * const input = {
110
+ * InstanceId: "i-abcd1234",
111
+ * ServiceId: "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-e4anhexample0004"
112
+ * };
113
+ * const command = new GetInstanceCommand(input);
114
+ * const response = await client.send(command);
115
+ * /* response is
116
+ * {
117
+ * Instance: {
118
+ * Attributes: {
119
+ * AWS_INSTANCE_IPV4: "192.0.2.44",
120
+ * AWS_INSTANCE_PORT: "80",
121
+ * color: "green",
122
+ * region: "us-west-2",
123
+ * stage: "beta"
124
+ * },
125
+ * CreatedByAccount: "111122223333",
126
+ * Id: "i-abcd1234"
127
+ * },
128
+ * ResourceOwner: "123456789012"
100
129
  * }
101
130
  * *\/
102
131
  * ```
@@ -99,6 +99,24 @@ declare const GetInstancesHealthStatusCommand_base: {
99
99
  * *\/
100
100
  * ```
101
101
  *
102
+ * @example Get instances health status using service ARN for shared namespace
103
+ * ```javascript
104
+ * // This example gets the current health status of instances using a service ARN instead of service ID. This is useful for checking health status of instances associated with shared namespaces.
105
+ * const input = {
106
+ * ServiceId: "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-e4anhexample0004"
107
+ * };
108
+ * const command = new GetInstancesHealthStatusCommand(input);
109
+ * const response = await client.send(command);
110
+ * /* response is
111
+ * {
112
+ * Status: {
113
+ * i-abcd1234: "HEALTHY",
114
+ * i-abcd1235: "UNHEALTHY"
115
+ * }
116
+ * }
117
+ * *\/
118
+ * ```
119
+ *
102
120
  * @public
103
121
  */
104
122
  export declare class GetInstancesHealthStatusCommand extends GetInstancesHealthStatusCommand_base {
@@ -69,6 +69,27 @@ declare const GetServiceAttributesCommand_base: {
69
69
  * <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>
70
70
  *
71
71
  *
72
+ * @example Get service attributes using service ARN
73
+ * ```javascript
74
+ * // Gets service attributes using a service ARN instead of service ID, useful when working with shared namespaces. Shows attributes for a service created by a sharee in a namespace owned by another account.
75
+ * const input = {
76
+ * ServiceId: "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678"
77
+ * };
78
+ * const command = new GetServiceAttributesCommand(input);
79
+ * const response = await client.send(command);
80
+ * /* response is
81
+ * {
82
+ * ServiceAttributes: {
83
+ * Attributes: {
84
+ * Port: "80"
85
+ * },
86
+ * ResourceOwner: "123456789012",
87
+ * ServiceArn: "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678"
88
+ * }
89
+ * }
90
+ * *\/
91
+ * ```
92
+ *
72
93
  * @example GetServiceAttributes Example
73
94
  * ```javascript
74
95
  * // This example gets the attributes for a specified service.
@@ -83,6 +104,7 @@ declare const GetServiceAttributesCommand_base: {
83
104
  * Attributes: {
84
105
  * port: "80"
85
106
  * },
107
+ * ResourceOwner: "123456789012",
86
108
  * ServiceArn: "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-e4anhexample0004"
87
109
  * }
88
110
  * }
@@ -93,6 +93,43 @@ declare const GetServiceCommand_base: {
93
93
  * <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>
94
94
  *
95
95
  *
96
+ * @example Get service using service ARN
97
+ * ```javascript
98
+ * // Gets service settings using a service ARN instead of service ID, useful when working with shared namespaces. Shows a service created by a sharee (111122223333) in a namespace owned by another account (123456789012).
99
+ * const input = {
100
+ * Id: "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678"
101
+ * };
102
+ * const command = new GetServiceCommand(input);
103
+ * const response = await client.send(command);
104
+ * /* response is
105
+ * {
106
+ * Service: {
107
+ * Arn: "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678",
108
+ * CreateDate: 1.7051616E9,
109
+ * CreatedByAccount: "111122223333",
110
+ * CreatorRequestId: "abcd1234-xmpl-5678-9012-abcd1234xmpl",
111
+ * Description: "Example service",
112
+ * DnsConfig: {
113
+ * DnsRecords: [
114
+ * {
115
+ * TTL: 300,
116
+ * Type: "A"
117
+ * }
118
+ * ],
119
+ * NamespaceId: "ns-abcd1234xmpl5678",
120
+ * RoutingPolicy: "MULTIVALUE"
121
+ * },
122
+ * Id: "srv-abcd1234xmpl5678",
123
+ * InstanceCount: 2,
124
+ * Name: "example-service",
125
+ * NamespaceId: "ns-abcd1234xmpl5678",
126
+ * ResourceOwner: "123456789012",
127
+ * Type: "DNS_HTTP"
128
+ * }
129
+ * }
130
+ * *\/
131
+ * ```
132
+ *
96
133
  * @public
97
134
  */
98
135
  export declare class GetServiceCommand extends GetServiceCommand_base {
@@ -99,6 +99,30 @@ declare const ListInstancesCommand_base: {
99
99
  * *\/
100
100
  * ```
101
101
  *
102
+ * @example List instances using service ARN for shared namespace
103
+ * ```javascript
104
+ * // This example lists instances using a service ARN instead of service ID. This is useful for listing instances associated with shared namespaces.
105
+ * const input = {
106
+ * ServiceId: "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-e4anhexample0004"
107
+ * };
108
+ * const command = new ListInstancesCommand(input);
109
+ * const response = await client.send(command);
110
+ * /* response is
111
+ * {
112
+ * Instances: [
113
+ * {
114
+ * Attributes: {
115
+ * AWS_INSTANCE_IPV4: "192.0.2.44",
116
+ * AWS_INSTANCE_PORT: "80"
117
+ * },
118
+ * Id: "i-abcd1234"
119
+ * }
120
+ * ],
121
+ * ResourceOwner: "123456789012"
122
+ * }
123
+ * *\/
124
+ * ```
125
+ *
102
126
  * @public
103
127
  */
104
128
  export declare class ListInstancesCommand extends ListInstancesCommand_base {
@@ -104,46 +104,106 @@ declare const ListNamespacesCommand_base: {
104
104
  * Namespaces: [
105
105
  * {
106
106
  * Arn: "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-a3ccy2e7e3a7rile",
107
- * CreateDate: 1.585354387357E9,
107
+ * CreateDate: 1.7051616E9,
108
108
  * Id: "ns-a3ccy2e7e3a7rile",
109
109
  * Name: "local",
110
110
  * Properties: {
111
111
  * DnsProperties: {
112
- * HostedZoneId: "Z06752353VBUDTC32S84S"
112
+ * HostedZoneId: "Z06752353VBUDTC32S84S",
113
+ * SOA: {
114
+ * TTL: 60
115
+ * }
113
116
  * },
114
117
  * HttpProperties: {
115
118
  * HttpName: "local"
116
119
  * }
117
120
  * },
121
+ * ResourceOwner: "123456789012",
122
+ * ServiceCount: 2,
118
123
  * Type: "DNS_PRIVATE"
119
124
  * },
120
125
  * {
121
126
  * Arn: "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-pocfyjtrsmwtvcxx",
122
- * CreateDate: 1.586468974698E9,
127
+ * CreateDate: 1.7051616E9,
123
128
  * Description: "My second namespace",
124
129
  * Id: "ns-pocfyjtrsmwtvcxx",
125
130
  * Name: "My-second-namespace",
126
131
  * Properties: {
127
- * DnsProperties: { /* empty *\/ },
132
+ * DnsProperties: {
133
+ * SOA: {
134
+ * TTL: 60
135
+ * }
136
+ * },
128
137
  * HttpProperties: {
129
138
  * HttpName: "My-second-namespace"
130
139
  * }
131
140
  * },
141
+ * ResourceOwner: "123456789012",
142
+ * ServiceCount: 1,
132
143
  * Type: "HTTP"
133
144
  * },
134
145
  * {
135
146
  * Arn: "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-ylexjili4cdxy3xm",
136
- * CreateDate: 1.587055896798E9,
147
+ * CreateDate: 1.7051616E9,
137
148
  * Id: "ns-ylexjili4cdxy3xm",
138
149
  * Name: "example.com",
139
150
  * Properties: {
140
151
  * DnsProperties: {
141
- * HostedZoneId: "Z09983722P0QME1B3KC8I"
152
+ * HostedZoneId: "Z09983722P0QME1B3KC8I",
153
+ * SOA: {
154
+ * TTL: 60
155
+ * }
142
156
  * },
143
157
  * HttpProperties: {
144
158
  * HttpName: "example.com"
145
159
  * }
146
160
  * },
161
+ * ResourceOwner: "123456789012",
162
+ * ServiceCount: 3,
163
+ * Type: "DNS_PRIVATE"
164
+ * }
165
+ * ]
166
+ * }
167
+ * *\/
168
+ * ```
169
+ *
170
+ * @example List namespaces filtered by resource owner
171
+ * ```javascript
172
+ * // This example shows how to list namespaces that are shared with you from other AWS accounts using the RESOURCE_OWNER filter.
173
+ * const input = {
174
+ * Filters: [
175
+ * {
176
+ * Name: "RESOURCE_OWNER",
177
+ * Values: [
178
+ * "OTHER_ACCOUNTS"
179
+ * ]
180
+ * }
181
+ * ]
182
+ * };
183
+ * const command = new ListNamespacesCommand(input);
184
+ * const response = await client.send(command);
185
+ * /* response is
186
+ * {
187
+ * Namespaces: [
188
+ * {
189
+ * Arn: "arn:aws:servicediscovery:us-west-2:111122223333:namespace/ns-abcd1234xmpl5678",
190
+ * CreateDate: 1.7051616E9,
191
+ * Description: "Example private DNS namespace",
192
+ * Id: "ns-abcd1234xmpl5678",
193
+ * Name: "example-namespace",
194
+ * Properties: {
195
+ * DnsProperties: {
196
+ * HostedZoneId: "Z1D633PJN98FT9",
197
+ * SOA: {
198
+ * TTL: 60
199
+ * }
200
+ * },
201
+ * HttpProperties: {
202
+ * HttpName: "example-namespace"
203
+ * }
204
+ * },
205
+ * ResourceOwner: "111122223333",
206
+ * ServiceCount: 2,
147
207
  * Type: "DNS_PRIVATE"
148
208
  * }
149
209
  * ]
@@ -114,6 +114,7 @@ declare const ListServicesCommand_base: {
114
114
  * {
115
115
  * Arn: "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita",
116
116
  * CreateDate: 1.587081768334E9,
117
+ * CreatedByAccount: "123456789012",
117
118
  * DnsConfig: {
118
119
  * DnsRecords: [
119
120
  * {
@@ -124,7 +125,9 @@ declare const ListServicesCommand_base: {
124
125
  * RoutingPolicy: "MULTIVALUE"
125
126
  * },
126
127
  * Id: "srv-p5zdwlg5uvvzjita",
127
- * Name: "myservice"
128
+ * Name: "myservice",
129
+ * ResourceOwner: "123456789012",
130
+ * Type: "DNS"
128
131
  * }
129
132
  * ]
130
133
  * }
@@ -143,6 +143,26 @@ declare const RegisterInstanceCommand_base: {
143
143
  * *\/
144
144
  * ```
145
145
  *
146
+ * @example Register instance using service ARN
147
+ * ```javascript
148
+ * // Registers an instance using a service ARN instead of service ID, useful when working with shared namespaces. Shows registering an instance to a service created by a sharee in a namespace owned by another account.
149
+ * const input = {
150
+ * Attributes: {
151
+ * AWS_INSTANCE_IPV4: "192.0.2.44",
152
+ * AWS_INSTANCE_PORT: "80"
153
+ * },
154
+ * InstanceId: "i-abcd1234xmpl5678",
155
+ * ServiceId: "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678"
156
+ * };
157
+ * const command = new RegisterInstanceCommand(input);
158
+ * const response = await client.send(command);
159
+ * /* response is
160
+ * {
161
+ * OperationId: "abcd1234-xmpl-5678-9012-abcd1234xmpl"
162
+ * }
163
+ * *\/
164
+ * ```
165
+ *
146
166
  * @public
147
167
  */
148
168
  export declare class RegisterInstanceCommand extends RegisterInstanceCommand_base {
@@ -93,6 +93,24 @@ declare const UpdateHttpNamespaceCommand_base: {
93
93
  * *\/
94
94
  * ```
95
95
  *
96
+ * @example Update HTTP namespace using namespace ARN for shared namespace
97
+ * ```javascript
98
+ * // This example updates an HTTP namespace using a namespace ARN instead of namespace ID.
99
+ * const input = {
100
+ * Id: "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-vh4nbmexample",
101
+ * Namespace: {
102
+ * Description: "Updated description for shared HTTP namespace."
103
+ * }
104
+ * };
105
+ * const command = new UpdateHttpNamespaceCommand(input);
106
+ * const response = await client.send(command);
107
+ * /* response is
108
+ * {
109
+ * OperationId: "ft52xe2koxhoeormaceymagglsdjyvexample"
110
+ * }
111
+ * *\/
112
+ * ```
113
+ *
96
114
  * @public
97
115
  */
98
116
  export declare class UpdateHttpNamespaceCommand extends UpdateHttpNamespaceCommand_base {
@@ -77,6 +77,21 @@ declare const UpdateInstanceCustomHealthStatusCommand_base: {
77
77
  * <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>
78
78
  *
79
79
  *
80
+ * @example Update instance custom health status using service ARN
81
+ * ```javascript
82
+ * // Updates instance custom health status using a service ARN instead of service ID, useful when working with shared namespaces.
83
+ * const input = {
84
+ * InstanceId: "i-abcd1234xmpl5678",
85
+ * ServiceId: "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678",
86
+ * Status: "HEALTHY"
87
+ * };
88
+ * const command = new UpdateInstanceCustomHealthStatusCommand(input);
89
+ * const response = await client.send(command);
90
+ * /* response is
91
+ * { /* empty *\/ }
92
+ * *\/
93
+ * ```
94
+ *
80
95
  * @example UpdateInstanceCustomHealthStatus Example
81
96
  * ```javascript
82
97
  * // This example submits a request to change the health status of an instance associated with a service with a custom health check to HEALTHY.
@@ -101,21 +101,20 @@ declare const UpdatePrivateDnsNamespaceCommand_base: {
101
101
  * *\/
102
102
  * ```
103
103
  *
104
- * @example To update a public DNS namespace
104
+ * @example Update private DNS namespace using namespace ARN for shared namespace
105
105
  * ```javascript
106
- * // The following example updates the description of a public DNS namespace.
106
+ * // This example updates a private DNS namespace using a namespace ARN instead of namespace ID.
107
107
  * const input = {
108
- * Id: "ns-bk3aEXAMPLE",
108
+ * Id: "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-bk3aexample",
109
109
  * Namespace: {
110
- * Description: "The updated namespace description."
111
- * },
112
- * UpdaterRequestId: ""
110
+ * Description: "Updated description for shared private DNS namespace."
111
+ * }
113
112
  * };
114
113
  * const command = new UpdatePrivateDnsNamespaceCommand(input);
115
114
  * const response = await client.send(command);
116
115
  * /* response is
117
116
  * {
118
- * OperationId: "ft52xe2koxhoeormaceymagglsdjEXAMPLE"
117
+ * OperationId: "ft52xe2koxhoeormaceymagglsdjyvexample"
119
118
  * }
120
119
  * *\/
121
120
  * ```
@@ -81,6 +81,43 @@ declare const UpdatePublicDnsNamespaceCommand_base: {
81
81
  * <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>
82
82
  *
83
83
  *
84
+ * @example To update a public DNS namespace
85
+ * ```javascript
86
+ * // The following example updates the description of a public DNS namespace.
87
+ * const input = {
88
+ * Id: "ns-bk3aEXAMPLE",
89
+ * Namespace: {
90
+ * Description: "The updated namespace description."
91
+ * },
92
+ * UpdaterRequestId: ""
93
+ * };
94
+ * const command = new UpdatePublicDnsNamespaceCommand(input);
95
+ * const response = await client.send(command);
96
+ * /* response is
97
+ * {
98
+ * OperationId: "ft52xe2koxhoeormaceymagglsdjEXAMPLE"
99
+ * }
100
+ * *\/
101
+ * ```
102
+ *
103
+ * @example Update public DNS namespace using namespace ARN for shared namespace
104
+ * ```javascript
105
+ * // This example updates a public DNS namespace using a namespace ARN instead of namespace ID.
106
+ * const input = {
107
+ * Id: "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-bk3aexample",
108
+ * Namespace: {
109
+ * Description: "Updated description for shared public DNS namespace."
110
+ * }
111
+ * };
112
+ * const command = new UpdatePublicDnsNamespaceCommand(input);
113
+ * const response = await client.send(command);
114
+ * /* response is
115
+ * {
116
+ * OperationId: "ft52xe2koxhoeormaceymagglsdjexample"
117
+ * }
118
+ * *\/
119
+ * ```
120
+ *
84
121
  * @public
85
122
  */
86
123
  export declare class UpdatePublicDnsNamespaceCommand extends UpdatePublicDnsNamespaceCommand_base {
@@ -68,6 +68,23 @@ declare const UpdateServiceAttributesCommand_base: {
68
68
  * <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>
69
69
  *
70
70
  *
71
+ * @example Update service attributes using service ARN
72
+ * ```javascript
73
+ * // Updates service attributes using a service ARN instead of service ID, useful when working with shared namespaces.
74
+ * const input = {
75
+ * Attributes: {
76
+ * Port: "8080",
77
+ * Protocol: "HTTP"
78
+ * },
79
+ * ServiceId: "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678"
80
+ * };
81
+ * const command = new UpdateServiceAttributesCommand(input);
82
+ * const response = await client.send(command);
83
+ * /* response is
84
+ * { /* empty *\/ }
85
+ * *\/
86
+ * ```
87
+ *
71
88
  * @example UpdateServiceAttributes Example
72
89
  * ```javascript
73
90
  * // This example submits a request to update the specified service to add a port attribute with the value 80.
@@ -152,6 +152,24 @@ declare const UpdateServiceCommand_base: {
152
152
  * *\/
153
153
  * ```
154
154
  *
155
+ * @example Update service using service ARN for shared namespace
156
+ * ```javascript
157
+ * // This example updates a service using a service ARN instead of service ID. This is useful for updating services associated with shared namespaces.
158
+ * const input = {
159
+ * Id: "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-e4anhexample0004",
160
+ * Service: {
161
+ * Description: "Updated service description for shared namespace"
162
+ * }
163
+ * };
164
+ * const command = new UpdateServiceCommand(input);
165
+ * const response = await client.send(command);
166
+ * /* response is
167
+ * {
168
+ * OperationId: "m35hsdrkxwjffm3xef4bxyy6vc3ewakx-jdn3y5g5"
169
+ * }
170
+ * *\/
171
+ * ```
172
+ *
155
173
  * @public
156
174
  */
157
175
  export declare class UpdateServiceCommand extends UpdateServiceCommand_base {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-servicediscovery",
3
3
  "description": "AWS SDK for JavaScript Servicediscovery Client for Node.js, Browser and React Native",
4
- "version": "3.873.0",
4
+ "version": "3.876.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-servicediscovery",
@@ -20,17 +20,17 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
- "@aws-sdk/core": "3.873.0",
24
- "@aws-sdk/credential-provider-node": "3.873.0",
23
+ "@aws-sdk/core": "3.876.0",
24
+ "@aws-sdk/credential-provider-node": "3.876.0",
25
25
  "@aws-sdk/middleware-host-header": "3.873.0",
26
- "@aws-sdk/middleware-logger": "3.873.0",
26
+ "@aws-sdk/middleware-logger": "3.876.0",
27
27
  "@aws-sdk/middleware-recursion-detection": "3.873.0",
28
- "@aws-sdk/middleware-user-agent": "3.873.0",
28
+ "@aws-sdk/middleware-user-agent": "3.876.0",
29
29
  "@aws-sdk/region-config-resolver": "3.873.0",
30
30
  "@aws-sdk/types": "3.862.0",
31
31
  "@aws-sdk/util-endpoints": "3.873.0",
32
32
  "@aws-sdk/util-user-agent-browser": "3.873.0",
33
- "@aws-sdk/util-user-agent-node": "3.873.0",
33
+ "@aws-sdk/util-user-agent-node": "3.876.0",
34
34
  "@smithy/config-resolver": "^4.1.5",
35
35
  "@smithy/core": "^3.8.0",
36
36
  "@smithy/fetch-http-handler": "^5.1.1",