Skip to content

Commit

Permalink
feat(clients): update command documentation examples as of 2024-12-16
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Dec 16, 2024
1 parent 8afc56c commit fbec847
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,20 @@ export interface DeleteServiceAttributesCommandOutput extends DeleteServiceAttri
* <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>
*
* @public
* @example DeleteServiceAttributes example
* ```javascript
* // Example: Delete service attribute by providing attribute key and service ID
* const input = {
* "Attributes": [
* "port"
* ],
* "ServiceId": "srv-e4anhexample0004"
* };
* const command = new DeleteServiceAttributesCommand(input);
* await client.send(command);
* // example id: example-delete-service-attributes-1587416462902
* ```
*
*/
export class DeleteServiceAttributesCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,27 @@ export interface GetServiceAttributesCommandOutput extends GetServiceAttributesR
* <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>
*
* @public
* @example GetServiceAttributes Example
* ```javascript
* // This example gets the attributes for a specified service.
* const input = {
* "ServiceId": "srv-e4anhexample0004"
* };
* const command = new GetServiceAttributesCommand(input);
* const response = await client.send(command);
* /* response ==
* {
* "ServiceAttributes": {
* "Attributes": {
* "port": "80"
* },
* "ServiceArn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-e4anhexample0004"
* }
* }
* *\/
* // example id: get-service-attributes-example-1590117234294
* ```
*
*/
export class GetServiceAttributesCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,20 @@ export interface UpdateServiceAttributesCommandOutput extends UpdateServiceAttri
* <p>Base exception class for all service exceptions from ServiceDiscovery service.</p>
*
* @public
* @example UpdateServiceAttributes Example
* ```javascript
* // This example submits a request to update the specified service to add a port attribute with the value 80.
* const input = {
* "Attributes": {
* "port": "80"
* },
* "ServiceId": "srv-e4anhexample0004"
* };
* const command = new UpdateServiceAttributesCommand(input);
* await client.send(command);
* // example id: update-service-attributes-example-1590117830880
* ```
*
*/
export class UpdateServiceAttributesCommand extends $Command
.classBuilder<
Expand Down

0 comments on commit fbec847

Please sign in to comment.