AWS CLI Command Reference

[ aws . opensearch ]

compare-domain-configuration

Description

Compares the metadata of two domains and reports where they differ. Use this operation to check that a secondary domain is configured consistently with its primary before you rely on it, because replication copies index data but does not copy domain metadata such as index templates, ingest pipelines, or security roles.

You choose which categories to compare. The response reports, for each category, how many items match, how many exist on only one domain, and which fields diverge.

See also: AWS API Documentation

Synopsis

  compare-domain-configuration
--source-domain-arn <value>
--target-domain-arn <value>
--categories <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--source-domain-arn (string) [required]

The Amazon Resource Name (ARN) of the domain to compare from.

Constraints:

  • min: 1
  • max: 512
  • pattern: arn:aws[a-z\-]*:[a-z]+:[a-z0-9\-]+:[0-9]+:domain\/[a-z0-9\-]+

--target-domain-arn (string) [required]

The Amazon Resource Name (ARN) of the domain to compare against.

Constraints:

  • min: 1
  • max: 512
  • pattern: arn:aws[a-z\-]*:[a-z]+:[a-z0-9\-]+:[0-9]+:domain\/[a-z0-9\-]+

--categories (list) [required]

The metadata categories to compare. At least one is required, and only the categories you name are read and returned.

  • aliases
  • alerting_monitors
  • cluster_settings
  • component_templates
  • ingest_pipelines
  • ism_policies — index state management policies
  • security_action_groups
  • security_internal_users
  • security_role_mappings
  • security_roles
  • templates — index templates

The set of categories grows over time, so this list is not fixed. A category the service does not recognise is rejected with the supported categories named in the error message.

Constraints:

  • min: 1
  • max: 20

(string)

Constraints:

  • min: 1
  • max: 128

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

SourceDomainArn -> (string)

The Amazon Resource Name (ARN) of the domain that was compared from.

Constraints:

  • min: 1
  • max: 512
  • pattern: arn:aws[a-z\-]*:[a-z]+:[a-z0-9\-]+:[0-9]+:domain\/[a-z0-9\-]+

TargetDomainArn -> (string)

The Amazon Resource Name (ARN) of the domain that was compared against.

Constraints:

  • min: 1
  • max: 512
  • pattern: arn:aws[a-z\-]*:[a-z]+:[a-z0-9\-]+:[0-9]+:domain\/[a-z0-9\-]+

Categories -> (map)

The comparison result for each category you requested, keyed by category name.

Constraints:

  • max: 20

key -> (string)

Constraints:

  • min: 1
  • max: 128

value -> (structure)

The result of comparing one metadata category between two domains.

Status -> (string)

Whether the category was compared successfully. compared means the result is complete; error means the category could not be read.

Possible values:

  • compared
  • error

InSync -> (integer)

The number of items that are identical on both domains.

Constraints:

  • min: 0

SourceOnly -> (integer)

The number of items that exist only on the source domain.

Constraints:

  • min: 0

TargetOnly -> (integer)

The number of items that exist only on the target domain.

Constraints:

  • min: 0

Diverged -> (integer)

The number of items that exist on both domains but differ.

Constraints:

  • min: 0

Items -> (structure)

The names of the items that differ, and for diverging items, the fields that differ.

SourceOnly -> (list)

The names of items that exist only on the source domain.

Constraints:

  • max: 1000

(string)

Constraints:

  • max: 256

TargetOnly -> (list)

The names of items that exist only on the target domain.

Constraints:

  • max: 1000

(string)

Constraints:

  • max: 256

Diverged -> (list)

The items that exist on both domains but differ, with the diverging fields.

Constraints:

  • max: 1000

(structure)

An item that exists on both domains but whose contents differ.

Name -> (string)

The name of the item.

Constraints:

  • max: 256

Fields -> (list)

The fields of the item that differ.

Constraints:

  • max: 100

(structure)

A single field that differs between the source and target copies of an item.

Path -> (string)

The location of the field within the item.

Constraints:

  • max: 512

SourceValue -> (string)

The field’s value on the source domain.

Constraints:

  • max: 10240

TargetValue -> (string)

The field’s value on the target domain.

Constraints:

  • max: 10240

Policy -> (string)

How the comparison treats this field.

Possible values:

  • redacted

Truncated -> (boolean)

Whether Items omits some differences because the category contained more than the response can carry. The counts remain complete when this is true .
© Copyright 2026, Amazon Web Services. Created using Sphinx.