aws-sdk-opensearchservice 1.114.0 → 1.116.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 861af9b8782a808a77c40d5eb09a2c2b86f2293a26cc530467384c56434f00bc
4
- data.tar.gz: 9a32db27fdfd23c31241d17d76923bf3b699e8d9cb12966e264070f951b25aa4
3
+ metadata.gz: abd88cd89c6043d86a10fdcb7f2627fdfc1471460051e789b17920eba95466bf
4
+ data.tar.gz: eb3dd023d73593e10e4ce2964032e4bdd56338d00b87410e72f8dfeb9c639d41
5
5
  SHA512:
6
- metadata.gz: c07fc8449e0a381cefd93cc5acff294cbffdb961c46a57688bfea41c59056902bde5988eb9ca4fc2cbbbc0316f65243f0f46536a957f8f5fc92b63c7dd8244dd
7
- data.tar.gz: 7c0235ce3d4ace4629abfb0f553cabd9c0c2be71090f71de09b4a021af8f54a9b81827eb95fb176bbcfdac8e1520716a9f6b44f2951801465cd73efad1cfc054
6
+ metadata.gz: 716725654cd726c3a0e5a143ef43745ce14caf400c3677698244384ebe38ae65273b7bfd33ba6a1dcd0d458c1bde020236bb6d0a6d7f60430b88c7ccf5757f1c
7
+ data.tar.gz: cfa86f3fd82acdf30ffed12ce0421059398dc5acc5c227830fc55e249446a7d8ae66cedbe9bcf74342ac3bf4afeef95bae2c8d7161711ffe52cc76a4c69f9edc
data/CHANGELOG.md CHANGED
@@ -1,6 +1,16 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.116.0 (2026-10-28)
5
+ ------------------
6
+
7
+ * Feature - This release adds APIs to simplify setting up a replication relationship between OpenSearch clusters. The APIs include new Switchover and Failover actions for planned switchovers and unplanned failovers to ensure high availability for OpenSearch in the event of disaster in a single region.
8
+
9
+ 1.115.0 (2026-10-21)
10
+ ------------------
11
+
12
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
13
+
4
14
  1.114.0 (2026-10-20)
5
15
  ------------------
6
16
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.114.0
1
+ 1.116.0
@@ -648,6 +648,56 @@ module Aws::OpenSearchService
648
648
  req.send_request(options)
649
649
  end
650
650
 
651
+ # Starts replicating a domain to a peer domain in another AWS Region. A
652
+ # domain can have one peer. The domain you call becomes the primary and
653
+ # the peer becomes the secondary, which receives a copy of the
654
+ # primary's indexes and serves read requests.
655
+ #
656
+ # Replication is established asynchronously. Use the
657
+ # `DescribeDomainReplication` operation to check whether the
658
+ # relationship has reached the `ACTIVE` state.
659
+ #
660
+ # @option params [required, String] :domain_name
661
+ # The name of an OpenSearch Service domain. Domain names are unique
662
+ # across the domains owned by an account within an Amazon Web Services
663
+ # Region.
664
+ #
665
+ # @option params [required, String] :peer_domain_arn
666
+ # The Amazon Resource Name (ARN) of the domain to replicate to. The peer
667
+ # must be in a different Region from the domain you are calling, and in
668
+ # the same AWS account.
669
+ #
670
+ # @option params [Boolean] :dry_run
671
+ # When `true`, validates the request and reports whether replication
672
+ # could be established, without changing either domain.
673
+ #
674
+ # @return [Types::AddReplicationPeerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
675
+ #
676
+ # * {Types::AddReplicationPeerResponse#domain_arn #domain_arn} => String
677
+ # * {Types::AddReplicationPeerResponse#status #status} => String
678
+ #
679
+ # @example Request syntax with placeholder values
680
+ #
681
+ # resp = client.add_replication_peer({
682
+ # domain_name: "DomainName", # required
683
+ # peer_domain_arn: "DomainArn", # required
684
+ # dry_run: false,
685
+ # })
686
+ #
687
+ # @example Response structure
688
+ #
689
+ # resp.domain_arn #=> String
690
+ # resp.status #=> String, one of "PENDING_SETUP", "ACTIVE", "SWITCHING_OVER", "FAILING_OVER", "PENDING_REMOVAL", "DETACHED", "EJECTED", "FAILED"
691
+ #
692
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AddReplicationPeer AWS API Documentation
693
+ #
694
+ # @overload add_replication_peer(params = {})
695
+ # @param [Hash] params ({})
696
+ def add_replication_peer(params = {}, options = {})
697
+ req = build_request(:add_replication_peer, params)
698
+ req.send_request(options)
699
+ end
700
+
651
701
  # Attaches tags to an existing Amazon OpenSearch Service domain, data
652
702
  # source, or application.
653
703
  #
@@ -1028,6 +1078,98 @@ module Aws::OpenSearchService
1028
1078
  req.send_request(options)
1029
1079
  end
1030
1080
 
1081
+ # Compares the metadata of two domains and reports where they differ.
1082
+ # Use this operation to check that a secondary domain is configured
1083
+ # consistently with its primary before you rely on it, because
1084
+ # replication copies index data but does not copy domain metadata such
1085
+ # as index templates, ingest pipelines, or security roles.
1086
+ #
1087
+ # You choose which categories to compare. The response reports, for each
1088
+ # category, how many items match, how many exist on only one domain, and
1089
+ # which fields diverge.
1090
+ #
1091
+ # @option params [required, String] :source_domain_arn
1092
+ # The Amazon Resource Name (ARN) of the domain to compare from.
1093
+ #
1094
+ # @option params [required, String] :target_domain_arn
1095
+ # The Amazon Resource Name (ARN) of the domain to compare against.
1096
+ #
1097
+ # @option params [required, Array<String>] :categories
1098
+ # The metadata categories to compare. At least one is required, and only
1099
+ # the categories you name are read and returned.
1100
+ #
1101
+ # * `aliases`
1102
+ #
1103
+ # * `alerting_monitors`
1104
+ #
1105
+ # * `cluster_settings`
1106
+ #
1107
+ # * `component_templates`
1108
+ #
1109
+ # * `ingest_pipelines`
1110
+ #
1111
+ # * `ism_policies` — index state management policies
1112
+ #
1113
+ # * `security_action_groups`
1114
+ #
1115
+ # * `security_internal_users`
1116
+ #
1117
+ # * `security_role_mappings`
1118
+ #
1119
+ # * `security_roles`
1120
+ #
1121
+ # * `templates` — index templates
1122
+ #
1123
+ # The set of categories grows over time, so this list is not fixed. A
1124
+ # category the service does not recognise is rejected with the supported
1125
+ # categories named in the error message.
1126
+ #
1127
+ # @return [Types::CompareDomainConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1128
+ #
1129
+ # * {Types::CompareDomainConfigurationResponse#source_domain_arn #source_domain_arn} => String
1130
+ # * {Types::CompareDomainConfigurationResponse#target_domain_arn #target_domain_arn} => String
1131
+ # * {Types::CompareDomainConfigurationResponse#categories #categories} => Hash&lt;String,Types::CategoryDiffResult&gt;
1132
+ #
1133
+ # @example Request syntax with placeholder values
1134
+ #
1135
+ # resp = client.compare_domain_configuration({
1136
+ # source_domain_arn: "DomainArn", # required
1137
+ # target_domain_arn: "DomainArn", # required
1138
+ # categories: ["MetadataCategory"], # required
1139
+ # })
1140
+ #
1141
+ # @example Response structure
1142
+ #
1143
+ # resp.source_domain_arn #=> String
1144
+ # resp.target_domain_arn #=> String
1145
+ # resp.categories #=> Hash
1146
+ # resp.categories["MetadataCategory"].status #=> String, one of "compared", "error"
1147
+ # resp.categories["MetadataCategory"].in_sync #=> Integer
1148
+ # resp.categories["MetadataCategory"].source_only #=> Integer
1149
+ # resp.categories["MetadataCategory"].target_only #=> Integer
1150
+ # resp.categories["MetadataCategory"].diverged #=> Integer
1151
+ # resp.categories["MetadataCategory"].items.source_only #=> Array
1152
+ # resp.categories["MetadataCategory"].items.source_only[0] #=> String
1153
+ # resp.categories["MetadataCategory"].items.target_only #=> Array
1154
+ # resp.categories["MetadataCategory"].items.target_only[0] #=> String
1155
+ # resp.categories["MetadataCategory"].items.diverged #=> Array
1156
+ # resp.categories["MetadataCategory"].items.diverged[0].name #=> String
1157
+ # resp.categories["MetadataCategory"].items.diverged[0].fields #=> Array
1158
+ # resp.categories["MetadataCategory"].items.diverged[0].fields[0].path #=> String
1159
+ # resp.categories["MetadataCategory"].items.diverged[0].fields[0].source_value #=> String
1160
+ # resp.categories["MetadataCategory"].items.diverged[0].fields[0].target_value #=> String
1161
+ # resp.categories["MetadataCategory"].items.diverged[0].fields[0].policy #=> String, one of "redacted"
1162
+ # resp.categories["MetadataCategory"].truncated #=> Boolean
1163
+ #
1164
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CompareDomainConfiguration AWS API Documentation
1165
+ #
1166
+ # @overload compare_domain_configuration(params = {})
1167
+ # @param [Hash] params ({})
1168
+ def compare_domain_configuration(params = {}, options = {})
1169
+ req = build_request(:compare_domain_configuration, params)
1170
+ req.send_request(options)
1171
+ end
1172
+
1031
1173
  # Creates an OpenSearch UI application. For more information, see [Using
1032
1174
  # the OpenSearch user interface in Amazon OpenSearch Service][1].
1033
1175
  #
@@ -3088,6 +3230,50 @@ module Aws::OpenSearchService
3088
3230
  req.send_request(options)
3089
3231
  end
3090
3232
 
3233
+ # Describes the replication arrangement that a domain participates in,
3234
+ # including the domain's role and the state of its relationship with
3235
+ # each peer.
3236
+ #
3237
+ # A domain that is not replicating is returned with an empty `Peers`
3238
+ # list and no `Role`. Returns `ResourceNotFoundException` if the domain
3239
+ # does not exist.
3240
+ #
3241
+ # @option params [required, String] :domain_name
3242
+ # The name of an OpenSearch Service domain. Domain names are unique
3243
+ # across the domains owned by an account within an Amazon Web Services
3244
+ # Region.
3245
+ #
3246
+ # @return [Types::DescribeDomainReplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3247
+ #
3248
+ # * {Types::DescribeDomainReplicationResponse#domain_arn #domain_arn} => String
3249
+ # * {Types::DescribeDomainReplicationResponse#role #role} => String
3250
+ # * {Types::DescribeDomainReplicationResponse#peers #peers} => Array&lt;Types::ReplicationPeer&gt;
3251
+ #
3252
+ # @example Request syntax with placeholder values
3253
+ #
3254
+ # resp = client.describe_domain_replication({
3255
+ # domain_name: "DomainName", # required
3256
+ # })
3257
+ #
3258
+ # @example Response structure
3259
+ #
3260
+ # resp.domain_arn #=> String
3261
+ # resp.role #=> String, one of "PRIMARY", "SECONDARY"
3262
+ # resp.peers #=> Array
3263
+ # resp.peers[0].peer_domain_arn #=> String
3264
+ # resp.peers[0].peer_role #=> String, one of "PRIMARY", "SECONDARY"
3265
+ # resp.peers[0].status #=> String, one of "PENDING_SETUP", "ACTIVE", "SWITCHING_OVER", "FAILING_OVER", "PENDING_REMOVAL", "DETACHED", "EJECTED", "FAILED"
3266
+ # resp.peers[0].status_message #=> String
3267
+ #
3268
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainReplication AWS API Documentation
3269
+ #
3270
+ # @overload describe_domain_replication(params = {})
3271
+ # @param [Hash] params ({})
3272
+ def describe_domain_replication(params = {}, options = {})
3273
+ req = build_request(:describe_domain_replication, params)
3274
+ req.send_request(options)
3275
+ end
3276
+
3091
3277
  # Returns domain configuration information about the specified Amazon
3092
3278
  # OpenSearch Service domains.
3093
3279
  #
@@ -4074,6 +4260,58 @@ module Aws::OpenSearchService
4074
4260
  req.send_request(options)
4075
4261
  end
4076
4262
 
4263
+ # Promotes a secondary domain to primary without coordinating with the
4264
+ # current primary. Use this operation when the primary is unreachable
4265
+ # and you cannot wait for it to recover.
4266
+ #
4267
+ # Writes that had not yet replicated when the primary became unreachable
4268
+ # are lost. You must set `AllowDataLoss` to acknowledge this. To promote
4269
+ # a domain without losing writes, use the `SwitchoverReplication`
4270
+ # operation instead.
4271
+ #
4272
+ # Call this operation in the Region of the domain you want to promote.
4273
+ #
4274
+ # @option params [required, String] :domain_name
4275
+ # The name of an OpenSearch Service domain. Domain names are unique
4276
+ # across the domains owned by an account within an Amazon Web Services
4277
+ # Region.
4278
+ #
4279
+ # @option params [required, String] :peer_domain_arn
4280
+ # The Amazon Resource Name (ARN) of the relationship's current primary.
4281
+ # The request is rejected if this domain is no longer the peer of the
4282
+ # domain you are calling.
4283
+ #
4284
+ # @option params [required, Boolean] :allow_data_loss
4285
+ # Acknowledges that writes which had not yet replicated are lost. You
4286
+ # must set this to `true`; the request is rejected otherwise.
4287
+ #
4288
+ # @return [Types::FailoverReplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4289
+ #
4290
+ # * {Types::FailoverReplicationResponse#domain_arn #domain_arn} => String
4291
+ # * {Types::FailoverReplicationResponse#status #status} => String
4292
+ #
4293
+ # @example Request syntax with placeholder values
4294
+ #
4295
+ # resp = client.failover_replication({
4296
+ # domain_name: "DomainName", # required
4297
+ # peer_domain_arn: "DomainArn", # required
4298
+ # allow_data_loss: false, # required
4299
+ # })
4300
+ #
4301
+ # @example Response structure
4302
+ #
4303
+ # resp.domain_arn #=> String
4304
+ # resp.status #=> String, one of "PENDING_SETUP", "ACTIVE", "SWITCHING_OVER", "FAILING_OVER", "PENDING_REMOVAL", "DETACHED", "EJECTED", "FAILED"
4305
+ #
4306
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/FailoverReplication AWS API Documentation
4307
+ #
4308
+ # @overload failover_replication(params = {})
4309
+ # @param [Hash] params ({})
4310
+ def failover_replication(params = {}, options = {})
4311
+ req = build_request(:failover_replication, params)
4312
+ req.send_request(options)
4313
+ end
4314
+
4077
4315
  # Retrieves the configuration and status of an existing OpenSearch
4078
4316
  # application.
4079
4317
  #
@@ -5671,6 +5909,46 @@ module Aws::OpenSearchService
5671
5909
  req.send_request(options)
5672
5910
  end
5673
5911
 
5912
+ # Stops replicating a domain to its peer. Replication ends for both
5913
+ # domains, and each domain keeps the data it holds at that point.
5914
+ # Neither domain is deleted.
5915
+ #
5916
+ # @option params [required, String] :domain_name
5917
+ # The name of an OpenSearch Service domain. Domain names are unique
5918
+ # across the domains owned by an account within an Amazon Web Services
5919
+ # Region.
5920
+ #
5921
+ # @option params [required, String] :peer_domain_arn
5922
+ # The Amazon Resource Name (ARN) of the peer to stop replicating with.
5923
+ # Both domains are named so that the request identifies exactly one
5924
+ # replication relationship.
5925
+ #
5926
+ # @return [Types::RemoveReplicationPeerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5927
+ #
5928
+ # * {Types::RemoveReplicationPeerResponse#domain_arn #domain_arn} => String
5929
+ # * {Types::RemoveReplicationPeerResponse#status #status} => String
5930
+ #
5931
+ # @example Request syntax with placeholder values
5932
+ #
5933
+ # resp = client.remove_replication_peer({
5934
+ # domain_name: "DomainName", # required
5935
+ # peer_domain_arn: "DomainArn", # required
5936
+ # })
5937
+ #
5938
+ # @example Response structure
5939
+ #
5940
+ # resp.domain_arn #=> String
5941
+ # resp.status #=> String, one of "PENDING_SETUP", "ACTIVE", "SWITCHING_OVER", "FAILING_OVER", "PENDING_REMOVAL", "DETACHED", "EJECTED", "FAILED"
5942
+ #
5943
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/RemoveReplicationPeer AWS API Documentation
5944
+ #
5945
+ # @overload remove_replication_peer(params = {})
5946
+ # @param [Hash] params ({})
5947
+ def remove_replication_peer(params = {}, options = {})
5948
+ req = build_request(:remove_replication_peer, params)
5949
+ req.send_request(options)
5950
+ end
5951
+
5674
5952
  # Removes the specified set of tags from an Amazon OpenSearch Service
5675
5953
  # domain, data source, or application. For more information, see [
5676
5954
  # Tagging Amazon OpenSearch Service resources][1].
@@ -5955,6 +6233,51 @@ module Aws::OpenSearchService
5955
6233
  req.send_request(options)
5956
6234
  end
5957
6235
 
6236
+ # Promotes a secondary domain to primary, coordinating with the current
6237
+ # primary so that no writes are lost. Use this operation for planned
6238
+ # role changes, such as testing your recovery procedure or moving write
6239
+ # traffic to another Region.
6240
+ #
6241
+ # Call this operation in the Region of the domain you want to promote.
6242
+ # If the current primary is unreachable, use the `FailoverReplication`
6243
+ # operation instead.
6244
+ #
6245
+ # @option params [required, String] :domain_name
6246
+ # The name of an OpenSearch Service domain. Domain names are unique
6247
+ # across the domains owned by an account within an Amazon Web Services
6248
+ # Region.
6249
+ #
6250
+ # @option params [required, String] :peer_domain_arn
6251
+ # The Amazon Resource Name (ARN) of the relationship's current primary.
6252
+ # The request is rejected if this domain is no longer the peer of the
6253
+ # domain you are calling.
6254
+ #
6255
+ # @return [Types::SwitchoverReplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6256
+ #
6257
+ # * {Types::SwitchoverReplicationResponse#domain_arn #domain_arn} => String
6258
+ # * {Types::SwitchoverReplicationResponse#status #status} => String
6259
+ #
6260
+ # @example Request syntax with placeholder values
6261
+ #
6262
+ # resp = client.switchover_replication({
6263
+ # domain_name: "DomainName", # required
6264
+ # peer_domain_arn: "DomainArn", # required
6265
+ # })
6266
+ #
6267
+ # @example Response structure
6268
+ #
6269
+ # resp.domain_arn #=> String
6270
+ # resp.status #=> String, one of "PENDING_SETUP", "ACTIVE", "SWITCHING_OVER", "FAILING_OVER", "PENDING_REMOVAL", "DETACHED", "EJECTED", "FAILED"
6271
+ #
6272
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/SwitchoverReplication AWS API Documentation
6273
+ #
6274
+ # @overload switchover_replication(params = {})
6275
+ # @param [Hash] params ({})
6276
+ def switchover_replication(params = {}, options = {})
6277
+ req = build_request(:switchover_replication, params)
6278
+ req.send_request(options)
6279
+ end
6280
+
5958
6281
  # Updates the configuration and settings of an existing OpenSearch
5959
6282
  # application.
5960
6283
  #
@@ -7138,7 +7461,7 @@ module Aws::OpenSearchService
7138
7461
  tracer: tracer
7139
7462
  )
7140
7463
  context[:gem_name] = 'aws-sdk-opensearchservice'
7141
- context[:gem_version] = '1.114.0'
7464
+ context[:gem_version] = '1.116.0'
7142
7465
  Seahorse::Client::Request.new(handlers, context)
7143
7466
  end
7144
7467