UpdateService
Submits a request to perform the following operations:
-
Update the TTL setting for existing
DnsRecordsconfigurations -
Add, update, or delete
HealthCheckConfigfor a specified serviceNote
You can't add, update, or delete a
HealthCheckCustomConfigconfiguration.
For public and private DNS namespaces, note the following:
-
If you omit any existing
DnsRecordsorHealthCheckConfigconfigurations from anUpdateServicerequest, the configurations are deleted from the service. -
If you omit an existing
HealthCheckCustomConfigconfiguration from anUpdateServicerequest, the configuration isn't deleted from the service.
When you update settings for a service, AWS Cloud Map also updates the corresponding settings in all the records and health checks that were created by using the specified service.
Request Syntax
{
"Id": "string",
"Service": {
"Description": "string",
"DnsConfig": {
"DnsRecords": [
{
"TTL": number,
"Type": "string"
}
]
},
"HealthCheckConfig": {
"FailureThreshold": number,
"ResourcePath": "string",
"Type": "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.
- Id
-
The ID of the service that you want to update.
Type: String
Length Constraints: Maximum length of 64.
Required: Yes
- Service
-
A complex type that contains the new settings for the service. You can specify a maximum of 30 attributes (key-value pairs).
Type: ServiceChange object
Required: Yes
Response Syntax
{
"OperationId": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- OperationId
-
A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.
Type: String
Length Constraints: Maximum length of 255.
Errors
For information about the errors that are common to all actions, see Common Errors.
- DuplicateRequest
-
The operation is already in progress.
HTTP Status Code: 400
- 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
- ServiceNotFound
-
No service exists with the specified ID.
HTTP Status Code: 400
Examples
UpdateService Example
This example updates the TTL and the HealthCheckConfig settings of the specified service.
Sample Request
POST / HTTP/1.1
host:servicediscovery.us-west-2.amazonaws.com
x-amz-date:20181118T211814Z
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.UpdateService
content-type:application/x-amz-json-1.1
content-length:[number of characters in the JSON string]
{
"Id": "srv-e4anhexample0004",
"Service": {
"HealthCheckConfig": {
"Type": "HTTP",
"ResourcePath": "/",
"FailureThreshold": 1
},
"DnsConfig": {
"DnsRecords": [
{
"Type": "A",
"TTL": 60
}
]
}
}
}Sample Response
HTTP/1.1 200
Content-Length: [number of characters in the JSON string]
Content-Type: application/x-amz-json-1.1
{
"OperationId":"m35hsdrkxwjffm3xef4bxyy6vc3ewakx-jdn3y5g5"
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
