Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . servicediscovery ]



Submits a request to perform the following operations:

  • Update the TTL setting for existing DnsRecords configurations
  • Add, update, or delete HealthCheckConfig for a specified service


You can't add, update, or delete a HealthCheckCustomConfig configuration.

For public and private DNS namespaces, note the following:

  • If you omit any existing DnsRecords or HealthCheckConfig configurations from an UpdateService request, the configurations are deleted from the service.
  • If you omit an existing HealthCheckCustomConfig configuration from an UpdateService request, the configuration is not 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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--id <value>
--service <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--id (string)

The ID of the service that you want to update.

--service (structure)

A complex type that contains the new settings for the service.

JSON Syntax:

  "Description": "string",
  "DnsConfig": {
    "DnsRecords": [
        "Type": "SRV"|"A"|"AAAA"|"CNAME",
        "TTL": long
  "HealthCheckConfig": {
    "Type": "HTTP"|"HTTPS"|"TCP",
    "ResourcePath": "string",
    "FailureThreshold": integer

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


OperationId -> (string)

A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation .