Skip to content

Commit c908c6c

Browse files
author
awstools
committedDec 13, 2024
feat(client-servicediscovery): AWS Cloud Map now supports service-level attributes, allowing you to associate custom metadata directly with services. These attributes can be retrieved, updated, and deleted using the new GetServiceAttributes, UpdateServiceAttributes, and DeleteServiceAttributes API calls.
·
v3.782.0v3.712.0
1 parent b525bd5 commit c908c6c

11 files changed

+983
-11
lines changed
 

‎clients/client-servicediscovery/README.md

+24
Original file line numberDiff line numberDiff line change
@@ -256,6 +256,14 @@ DeleteService
256256

257257
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/servicediscovery/command/DeleteServiceCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-servicediscovery/Interface/DeleteServiceCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-servicediscovery/Interface/DeleteServiceCommandOutput/)
258258

259+
</details>
260+
<details>
261+
<summary>
262+
DeleteServiceAttributes
263+
</summary>
264+
265+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/servicediscovery/command/DeleteServiceAttributesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-servicediscovery/Interface/DeleteServiceAttributesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-servicediscovery/Interface/DeleteServiceAttributesCommandOutput/)
266+
259267
</details>
260268
<details>
261269
<summary>
@@ -320,6 +328,14 @@ GetService
320328

321329
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/servicediscovery/command/GetServiceCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-servicediscovery/Interface/GetServiceCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-servicediscovery/Interface/GetServiceCommandOutput/)
322330

331+
</details>
332+
<details>
333+
<summary>
334+
GetServiceAttributes
335+
</summary>
336+
337+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/servicediscovery/command/GetServiceAttributesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-servicediscovery/Interface/GetServiceAttributesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-servicediscovery/Interface/GetServiceAttributesCommandOutput/)
338+
323339
</details>
324340
<details>
325341
<summary>
@@ -425,3 +441,11 @@ UpdateService
425441
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/servicediscovery/command/UpdateServiceCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-servicediscovery/Interface/UpdateServiceCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-servicediscovery/Interface/UpdateServiceCommandOutput/)
426442

427443
</details>
444+
<details>
445+
<summary>
446+
UpdateServiceAttributes
447+
</summary>
448+
449+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/servicediscovery/command/UpdateServiceAttributesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-servicediscovery/Interface/UpdateServiceAttributesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-servicediscovery/Interface/UpdateServiceAttributesCommandOutput/)
450+
451+
</details>

‎clients/client-servicediscovery/src/ServiceDiscovery.ts

+69
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,11 @@ import {
2727
DeleteNamespaceCommandInput,
2828
DeleteNamespaceCommandOutput,
2929
} from "./commands/DeleteNamespaceCommand";
30+
import {
31+
DeleteServiceAttributesCommand,
32+
DeleteServiceAttributesCommandInput,
33+
DeleteServiceAttributesCommandOutput,
34+
} from "./commands/DeleteServiceAttributesCommand";
3035
import {
3136
DeleteServiceCommand,
3237
DeleteServiceCommandInput,
@@ -63,6 +68,11 @@ import {
6368
GetOperationCommandInput,
6469
GetOperationCommandOutput,
6570
} from "./commands/GetOperationCommand";
71+
import {
72+
GetServiceAttributesCommand,
73+
GetServiceAttributesCommandInput,
74+
GetServiceAttributesCommandOutput,
75+
} from "./commands/GetServiceAttributesCommand";
6676
import { GetServiceCommand, GetServiceCommandInput, GetServiceCommandOutput } from "./commands/GetServiceCommand";
6777
import {
6878
ListInstancesCommand,
@@ -120,6 +130,11 @@ import {
120130
UpdatePublicDnsNamespaceCommandInput,
121131
UpdatePublicDnsNamespaceCommandOutput,
122132
} from "./commands/UpdatePublicDnsNamespaceCommand";
133+
import {
134+
UpdateServiceAttributesCommand,
135+
UpdateServiceAttributesCommandInput,
136+
UpdateServiceAttributesCommandOutput,
137+
} from "./commands/UpdateServiceAttributesCommand";
123138
import {
124139
UpdateServiceCommand,
125140
UpdateServiceCommandInput,
@@ -134,6 +149,7 @@ const commands = {
134149
CreateServiceCommand,
135150
DeleteNamespaceCommand,
136151
DeleteServiceCommand,
152+
DeleteServiceAttributesCommand,
137153
DeregisterInstanceCommand,
138154
DiscoverInstancesCommand,
139155
DiscoverInstancesRevisionCommand,
@@ -142,6 +158,7 @@ const commands = {
142158
GetNamespaceCommand,
143159
GetOperationCommand,
144160
GetServiceCommand,
161+
GetServiceAttributesCommand,
145162
ListInstancesCommand,
146163
ListNamespacesCommand,
147164
ListOperationsCommand,
@@ -155,6 +172,7 @@ const commands = {
155172
UpdatePrivateDnsNamespaceCommand,
156173
UpdatePublicDnsNamespaceCommand,
157174
UpdateServiceCommand,
175+
UpdateServiceAttributesCommand,
158176
};
159177

160178
export interface ServiceDiscovery {
@@ -245,6 +263,23 @@ export interface ServiceDiscovery {
245263
cb: (err: any, data?: DeleteServiceCommandOutput) => void
246264
): void;
247265

266+
/**
267+
* @see {@link DeleteServiceAttributesCommand}
268+
*/
269+
deleteServiceAttributes(
270+
args: DeleteServiceAttributesCommandInput,
271+
options?: __HttpHandlerOptions
272+
): Promise<DeleteServiceAttributesCommandOutput>;
273+
deleteServiceAttributes(
274+
args: DeleteServiceAttributesCommandInput,
275+
cb: (err: any, data?: DeleteServiceAttributesCommandOutput) => void
276+
): void;
277+
deleteServiceAttributes(
278+
args: DeleteServiceAttributesCommandInput,
279+
options: __HttpHandlerOptions,
280+
cb: (err: any, data?: DeleteServiceAttributesCommandOutput) => void
281+
): void;
282+
248283
/**
249284
* @see {@link DeregisterInstanceCommand}
250285
*/
@@ -357,6 +392,23 @@ export interface ServiceDiscovery {
357392
cb: (err: any, data?: GetServiceCommandOutput) => void
358393
): void;
359394

395+
/**
396+
* @see {@link GetServiceAttributesCommand}
397+
*/
398+
getServiceAttributes(
399+
args: GetServiceAttributesCommandInput,
400+
options?: __HttpHandlerOptions
401+
): Promise<GetServiceAttributesCommandOutput>;
402+
getServiceAttributes(
403+
args: GetServiceAttributesCommandInput,
404+
cb: (err: any, data?: GetServiceAttributesCommandOutput) => void
405+
): void;
406+
getServiceAttributes(
407+
args: GetServiceAttributesCommandInput,
408+
options: __HttpHandlerOptions,
409+
cb: (err: any, data?: GetServiceAttributesCommandOutput) => void
410+
): void;
411+
360412
/**
361413
* @see {@link ListInstancesCommand}
362414
*/
@@ -544,6 +596,23 @@ export interface ServiceDiscovery {
544596
options: __HttpHandlerOptions,
545597
cb: (err: any, data?: UpdateServiceCommandOutput) => void
546598
): void;
599+
600+
/**
601+
* @see {@link UpdateServiceAttributesCommand}
602+
*/
603+
updateServiceAttributes(
604+
args: UpdateServiceAttributesCommandInput,
605+
options?: __HttpHandlerOptions
606+
): Promise<UpdateServiceAttributesCommandOutput>;
607+
updateServiceAttributes(
608+
args: UpdateServiceAttributesCommandInput,
609+
cb: (err: any, data?: UpdateServiceAttributesCommandOutput) => void
610+
): void;
611+
updateServiceAttributes(
612+
args: UpdateServiceAttributesCommandInput,
613+
options: __HttpHandlerOptions,
614+
cb: (err: any, data?: UpdateServiceAttributesCommandOutput) => void
615+
): void;
547616
}
548617

549618
/**

‎clients/client-servicediscovery/src/ServiceDiscoveryClient.ts

+18
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,10 @@ import {
6767
} from "./commands/CreatePublicDnsNamespaceCommand";
6868
import { CreateServiceCommandInput, CreateServiceCommandOutput } from "./commands/CreateServiceCommand";
6969
import { DeleteNamespaceCommandInput, DeleteNamespaceCommandOutput } from "./commands/DeleteNamespaceCommand";
70+
import {
71+
DeleteServiceAttributesCommandInput,
72+
DeleteServiceAttributesCommandOutput,
73+
} from "./commands/DeleteServiceAttributesCommand";
7074
import { DeleteServiceCommandInput, DeleteServiceCommandOutput } from "./commands/DeleteServiceCommand";
7175
import { DeregisterInstanceCommandInput, DeregisterInstanceCommandOutput } from "./commands/DeregisterInstanceCommand";
7276
import { DiscoverInstancesCommandInput, DiscoverInstancesCommandOutput } from "./commands/DiscoverInstancesCommand";
@@ -81,6 +85,10 @@ import {
8185
} from "./commands/GetInstancesHealthStatusCommand";
8286
import { GetNamespaceCommandInput, GetNamespaceCommandOutput } from "./commands/GetNamespaceCommand";
8387
import { GetOperationCommandInput, GetOperationCommandOutput } from "./commands/GetOperationCommand";
88+
import {
89+
GetServiceAttributesCommandInput,
90+
GetServiceAttributesCommandOutput,
91+
} from "./commands/GetServiceAttributesCommand";
8492
import { GetServiceCommandInput, GetServiceCommandOutput } from "./commands/GetServiceCommand";
8593
import { ListInstancesCommandInput, ListInstancesCommandOutput } from "./commands/ListInstancesCommand";
8694
import { ListNamespacesCommandInput, ListNamespacesCommandOutput } from "./commands/ListNamespacesCommand";
@@ -109,6 +117,10 @@ import {
109117
UpdatePublicDnsNamespaceCommandInput,
110118
UpdatePublicDnsNamespaceCommandOutput,
111119
} from "./commands/UpdatePublicDnsNamespaceCommand";
120+
import {
121+
UpdateServiceAttributesCommandInput,
122+
UpdateServiceAttributesCommandOutput,
123+
} from "./commands/UpdateServiceAttributesCommand";
112124
import { UpdateServiceCommandInput, UpdateServiceCommandOutput } from "./commands/UpdateServiceCommand";
113125
import {
114126
ClientInputEndpointParameters,
@@ -130,6 +142,7 @@ export type ServiceInputTypes =
130142
| CreatePublicDnsNamespaceCommandInput
131143
| CreateServiceCommandInput
132144
| DeleteNamespaceCommandInput
145+
| DeleteServiceAttributesCommandInput
133146
| DeleteServiceCommandInput
134147
| DeregisterInstanceCommandInput
135148
| DiscoverInstancesCommandInput
@@ -138,6 +151,7 @@ export type ServiceInputTypes =
138151
| GetInstancesHealthStatusCommandInput
139152
| GetNamespaceCommandInput
140153
| GetOperationCommandInput
154+
| GetServiceAttributesCommandInput
141155
| GetServiceCommandInput
142156
| ListInstancesCommandInput
143157
| ListNamespacesCommandInput
@@ -151,6 +165,7 @@ export type ServiceInputTypes =
151165
| UpdateInstanceCustomHealthStatusCommandInput
152166
| UpdatePrivateDnsNamespaceCommandInput
153167
| UpdatePublicDnsNamespaceCommandInput
168+
| UpdateServiceAttributesCommandInput
154169
| UpdateServiceCommandInput;
155170

156171
/**
@@ -162,6 +177,7 @@ export type ServiceOutputTypes =
162177
| CreatePublicDnsNamespaceCommandOutput
163178
| CreateServiceCommandOutput
164179
| DeleteNamespaceCommandOutput
180+
| DeleteServiceAttributesCommandOutput
165181
| DeleteServiceCommandOutput
166182
| DeregisterInstanceCommandOutput
167183
| DiscoverInstancesCommandOutput
@@ -170,6 +186,7 @@ export type ServiceOutputTypes =
170186
| GetInstancesHealthStatusCommandOutput
171187
| GetNamespaceCommandOutput
172188
| GetOperationCommandOutput
189+
| GetServiceAttributesCommandOutput
173190
| GetServiceCommandOutput
174191
| ListInstancesCommandOutput
175192
| ListNamespacesCommandOutput
@@ -183,6 +200,7 @@ export type ServiceOutputTypes =
183200
| UpdateInstanceCustomHealthStatusCommandOutput
184201
| UpdatePrivateDnsNamespaceCommandOutput
185202
| UpdatePublicDnsNamespaceCommandOutput
203+
| UpdateServiceAttributesCommandOutput
186204
| UpdateServiceCommandOutput;
187205

188206
/**

‎clients/client-servicediscovery/src/commands/DeleteServiceAttributesCommand.ts

+100
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
// smithy-typescript generated code
2+
import { getEndpointPlugin } from "@smithy/middleware-endpoint";
3+
import { getSerdePlugin } from "@smithy/middleware-serde";
4+
import { Command as $Command } from "@smithy/smithy-client";
5+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
6+
7+
import { commonParams } from "../endpoint/EndpointParameters";
8+
import { DeleteServiceAttributesRequest, DeleteServiceAttributesResponse } from "../models/models_0";
9+
import { de_DeleteServiceAttributesCommand, se_DeleteServiceAttributesCommand } from "../protocols/Aws_json1_1";
10+
import { ServiceDiscoveryClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ServiceDiscoveryClient";
11+
12+
/**
13+
* @public
14+
*/
15+
export type { __MetadataBearer };
16+
export { $Command };
17+
/**
18+
* @public
19+
*
20+
* The input for {@link DeleteServiceAttributesCommand}.
21+
*/
22+
export interface DeleteServiceAttributesCommandInput extends DeleteServiceAttributesRequest {}
23+
/**
24+
* @public
25+
*
26+
* The output of {@link DeleteServiceAttributesCommand}.
27+
*/
28+
export interface DeleteServiceAttributesCommandOutput extends DeleteServiceAttributesResponse, __MetadataBearer {}
29+
30+
/**
31+
* <p>Deletes specific attributes associated with a service.</p>
32+
* @example
33+
* Use a bare-bones client and the command you need to make an API call.
34+
* ```javascript
35+
* import { ServiceDiscoveryClient, DeleteServiceAttributesCommand } from "@aws-sdk/client-servicediscovery"; // ES Modules import
36+
* // const { ServiceDiscoveryClient, DeleteServiceAttributesCommand } = require("@aws-sdk/client-servicediscovery"); // CommonJS import
37+
* const client = new ServiceDiscoveryClient(config);
38+
* const input = { // DeleteServiceAttributesRequest
39+
* ServiceId: "STRING_VALUE", // required
40+
* Attributes: [ // ServiceAttributeKeyList // required
41+
* "STRING_VALUE",
42+
* ],
43+
* };
44+
* const command = new DeleteServiceAttributesCommand(input);
45+
* const response = await client.send(command);
46+
* // {};
47+
*
48+
* ```
49+
*
50+
* @param DeleteServiceAttributesCommandInput - {@link DeleteServiceAttributesCommandInput}
51+
* @returns {@link DeleteServiceAttributesCommandOutput}
52+
* @see {@link DeleteServiceAttributesCommandInput} for command's `input` shape.
53+
* @see {@link DeleteServiceAttributesCommandOutput} for command's `response` shape.
54+
* @see {@link ServiceDiscoveryClientResolvedConfig | config} for ServiceDiscoveryClient's `config` shape.
55+
*
56+
* @throws {@link InvalidInput} (client fault)
57+
* <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
58+
* might be outside the allowed range, or a string value might exceed length constraints.</p>
59+
*
60+
* @throws {@link ServiceNotFound} (client fault)
61+
* <p>No service exists with the specified ID.</p>
62+
*
63+
* @throws {@link ServiceDiscoveryServiceException}
64+
* <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>
65+
*
66+
* @public
67+
*/
68+
export class DeleteServiceAttributesCommand extends $Command
69+
.classBuilder<
70+
DeleteServiceAttributesCommandInput,
71+
DeleteServiceAttributesCommandOutput,
72+
ServiceDiscoveryClientResolvedConfig,
73+
ServiceInputTypes,
74+
ServiceOutputTypes
75+
>()
76+
.ep(commonParams)
77+
.m(function (this: any, Command: any, cs: any, config: ServiceDiscoveryClientResolvedConfig, o: any) {
78+
return [
79+
getSerdePlugin(config, this.serialize, this.deserialize),
80+
getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
81+
];
82+
})
83+
.s("Route53AutoNaming_v20170314", "DeleteServiceAttributes", {})
84+
.n("ServiceDiscoveryClient", "DeleteServiceAttributesCommand")
85+
.f(void 0, void 0)
86+
.ser(se_DeleteServiceAttributesCommand)
87+
.de(de_DeleteServiceAttributesCommand)
88+
.build() {
89+
/** @internal type navigation helper, not in runtime. */
90+
protected declare static __types: {
91+
api: {
92+
input: DeleteServiceAttributesRequest;
93+
output: {};
94+
};
95+
sdk: {
96+
input: DeleteServiceAttributesCommandInput;
97+
output: DeleteServiceAttributesCommandOutput;
98+
};
99+
};
100+
}

‎clients/client-servicediscovery/src/commands/DeleteServiceCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface DeleteServiceCommandInput extends DeleteServiceRequest {}
2828
export interface DeleteServiceCommandOutput extends DeleteServiceResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Deletes a specified service. If the service still contains one or more registered instances, the request
31+
* <p>Deletes a specified service and all associated service attributes. If the service still contains one or more registered instances, the request
3232
* fails.</p>
3333
* @example
3434
* Use a bare-bones client and the command you need to make an API call.

0 commit comments

Comments
 (0)
Please sign in to comment.