UpdateServiceAttributes - AWS Cloud Map

UpdateServiceAttributes

Submits a request to update a specified service to add service-level attributes.

Request Syntax

{ "Attributes": { "string" : "string" }, "ServiceId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Attributes

A string map that contains attribute key-value pairs.

Type: String to string map

Map Entries: Maximum number of 30 items.

Key Length Constraints: Maximum length of 255.

Value Length Constraints: Maximum length of 1024.

Required: Yes

ServiceId

The ID of the service that you want to update.

Type: String

Length Constraints: Maximum length of 64.

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidInput

One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.

HTTP Status Code: 400

ServiceAttributesLimitExceededException

The attribute can't be added to the service because you've exceeded the quota for the number of attributes you can add to a service.

HTTP Status Code: 400

ServiceNotFound

No service exists with the specified ID.

HTTP Status Code: 400

Examples

UpdateServiceAttributes Example

This example API request updates the service srv-e4anhexample0004 to add an attribute Port with value 80.

Sample Request

POST / HTTP/1.1 host:servicediscovery.us-west-2.amazonaws.com x-amz-date:20241223T173136Z authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20181118/us-west-2/servicediscovery/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target, Signature=[calculated-signature] x-amz-target:Route53AutoNaming_v20170314.UpdateServiceAttributes content-type:application/x-amz-json-1.1 content-length:[number of characters in the JSON string] { "ServiceId": "srv-e4anhexample0004", "Attributes": { "Port":"80" } }

Sample Response

HTTP/1.1 200 Content-Length: [number of characters in the JSON string] Content-Type: application/x-amz-json-1.1 {}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: