aws-sdk-opensearchservice 1.77.0 → 1.78.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9042aaabb1e8d68a55f430c86e902fd392f0ba4ea85d051b4b1a530f1a4face
-  data.tar.gz: 905a6ee7ffd709d5b867d634786e0b8b853914afcf9f9e69de9dad0e71e53a9f
+  metadata.gz: 328f636e9d5ab1e580e98a2ba544378476764e2474787f7fef40996abf2fa7f4
+  data.tar.gz: 46943d115dbff697df040acd0b6315118c0a88580b90cbc7d83add8de014243b
 SHA512:
-  metadata.gz: f02e935e0a0875a414e1594f54798244ef7925e32255134f26c222f56932d54c69f8cbee8ad276d5ac040a87e945275b51c2209ae1742f65dfaaf982af6fbee3
-  data.tar.gz: ba584aabbe0e69c750eb816642f8f4ebe2930c59828843ec682f5b7340dd7a14b8b9270cd516295e87e5e88a1470fe21a37dd2faf3d97262d2baa1c805e3612c
+  metadata.gz: 94a59d49d73aff0ad15e3fa8a7c945b06ace848169590a21192973848eb20621c5cb56ba140c4726e15bde80a0ebd3d926551a2d0a77b9ab8d641c2a091a6f2e
+  data.tar.gz: d6f5a451d5e3294e729fa14816312006901d791018e5082f68e27effe9f225841a864684f76a84c6946342faa9f2c5e181328d18213b3abb7778531139491ad1

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.78.0 (2025-11-07)
+------------------
+
+* Feature - This release introduces the Default Application feature, allowing users to set, change, or unset a preferred OpenSearch UI application on a per-region basis for a streamlined and consistent user experience.
+
 1.77.0 (2025-10-28)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.77.0
+1.78.0

data/lib/aws-sdk-opensearchservice/client.rb

@@ -3663,6 +3663,28 @@ module Aws::OpenSearchService
       req.send_request(options)
     end
 
+    # Gets the ARN of the current default application.
+    #
+    # If the default application isn't set, the operation returns a
+    # resource not found error.
+    #
+    # @return [Types::GetDefaultApplicationSettingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetDefaultApplicationSettingResponse#application_arn #application_arn} => String
+    #
+    # @example Response structure
+    #
+    #   resp.application_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetDefaultApplicationSetting AWS API Documentation
+    #
+    # @overload get_default_application_setting(params = {})
+    # @param [Hash] params ({})
+    def get_default_application_setting(params = {}, options = {})
+      req = build_request(:get_default_application_setting, params)
+      req.send_request(options)
+    end
+
     # Returns detailed configuration information for a specific direct query
     # data source in Amazon OpenSearch Service.
     #
@@ -4618,6 +4640,51 @@ module Aws::OpenSearchService
       req.send_request(options)
     end
 
+    # Sets the default application to the application with the specified
+    # ARN.
+    #
+    # To remove the default application, use the
+    # `GetDefaultApplicationSetting` operation to get the current default
+    # and then call the `PutDefaultApplicationSetting` with the current
+    # applications ARN and the `setAsDefault` parameter set to `false`.
+    #
+    # @option params [required, String] :application_arn
+    #   The Amazon Resource Name (ARN) of the domain. See [Identifiers for IAM
+    #   Entities ][1] in *Using Amazon Web Services Identity and Access
+    #   Management* for more information.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html
+    #
+    # @option params [required, Boolean] :set_as_default
+    #   Set to true to set the specified ARN as the default application. Set
+    #   to false to clear the default application.
+    #
+    # @return [Types::PutDefaultApplicationSettingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::PutDefaultApplicationSettingResponse#application_arn #application_arn} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.put_default_application_setting({
+    #     application_arn: "ARN", # required
+    #     set_as_default: false, # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.application_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/PutDefaultApplicationSetting AWS API Documentation
+    #
+    # @overload put_default_application_setting(params = {})
+    # @param [Hash] params ({})
+    def put_default_application_setting(params = {}, options = {})
+      req = build_request(:put_default_application_setting, params)
+      req.send_request(options)
+    end
+
     # Allows the remote Amazon OpenSearch Service domain owner to reject an
     # inbound cross-cluster connection request.
     #
@@ -5843,7 +5910,7 @@ module Aws::OpenSearchService
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-opensearchservice'
-      context[:gem_version] = '1.77.0'
+      context[:gem_version] = '1.78.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-opensearchservice/client_api.rb

@@ -249,6 +249,8 @@ module Aws::OpenSearchService
     GetCompatibleVersionsResponse = Shapes::StructureShape.new(name: 'GetCompatibleVersionsResponse')
     GetDataSourceRequest = Shapes::StructureShape.new(name: 'GetDataSourceRequest')
     GetDataSourceResponse = Shapes::StructureShape.new(name: 'GetDataSourceResponse')
+    GetDefaultApplicationSettingRequest = Shapes::StructureShape.new(name: 'GetDefaultApplicationSettingRequest')
+    GetDefaultApplicationSettingResponse = Shapes::StructureShape.new(name: 'GetDefaultApplicationSettingResponse')
     GetDirectQueryDataSourceRequest = Shapes::StructureShape.new(name: 'GetDirectQueryDataSourceRequest')
     GetDirectQueryDataSourceResponse = Shapes::StructureShape.new(name: 'GetDirectQueryDataSourceResponse')
     GetDomainMaintenanceStatusRequest = Shapes::StructureShape.new(name: 'GetDomainMaintenanceStatusRequest')
@@ -416,6 +418,8 @@ module Aws::OpenSearchService
     PropertyValueType = Shapes::StringShape.new(name: 'PropertyValueType')
     PurchaseReservedInstanceOfferingRequest = Shapes::StructureShape.new(name: 'PurchaseReservedInstanceOfferingRequest')
     PurchaseReservedInstanceOfferingResponse = Shapes::StructureShape.new(name: 'PurchaseReservedInstanceOfferingResponse')
+    PutDefaultApplicationSettingRequest = Shapes::StructureShape.new(name: 'PutDefaultApplicationSettingRequest')
+    PutDefaultApplicationSettingResponse = Shapes::StructureShape.new(name: 'PutDefaultApplicationSettingResponse')
     RecurringCharge = Shapes::StructureShape.new(name: 'RecurringCharge')
     RecurringChargeList = Shapes::ListShape.new(name: 'RecurringChargeList')
     ReferencePath = Shapes::StringShape.new(name: 'ReferencePath')
@@ -1370,6 +1374,11 @@ module Aws::OpenSearchService
     GetDataSourceResponse.add_member(:status, Shapes::ShapeRef.new(shape: DataSourceStatus, location_name: "Status"))
     GetDataSourceResponse.struct_class = Types::GetDataSourceResponse
 
+    GetDefaultApplicationSettingRequest.struct_class = Types::GetDefaultApplicationSettingRequest
+
+    GetDefaultApplicationSettingResponse.add_member(:application_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "applicationArn"))
+    GetDefaultApplicationSettingResponse.struct_class = Types::GetDefaultApplicationSettingResponse
+
     GetDirectQueryDataSourceRequest.add_member(:data_source_name, Shapes::ShapeRef.new(shape: DirectQueryDataSourceName, required: true, location: "uri", location_name: "DataSourceName"))
     GetDirectQueryDataSourceRequest.struct_class = Types::GetDirectQueryDataSourceRequest
 
@@ -1805,6 +1814,13 @@ module Aws::OpenSearchService
     PurchaseReservedInstanceOfferingResponse.add_member(:reservation_name, Shapes::ShapeRef.new(shape: ReservationToken, location_name: "ReservationName"))
     PurchaseReservedInstanceOfferingResponse.struct_class = Types::PurchaseReservedInstanceOfferingResponse
 
+    PutDefaultApplicationSettingRequest.add_member(:application_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "applicationArn"))
+    PutDefaultApplicationSettingRequest.add_member(:set_as_default, Shapes::ShapeRef.new(shape: Boolean, required: true, location_name: "setAsDefault"))
+    PutDefaultApplicationSettingRequest.struct_class = Types::PutDefaultApplicationSettingRequest
+
+    PutDefaultApplicationSettingResponse.add_member(:application_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "applicationArn"))
+    PutDefaultApplicationSettingResponse.struct_class = Types::PutDefaultApplicationSettingResponse
+
     RecurringCharge.add_member(:recurring_charge_amount, Shapes::ShapeRef.new(shape: Double, location_name: "RecurringChargeAmount"))
     RecurringCharge.add_member(:recurring_charge_frequency, Shapes::ShapeRef.new(shape: String, location_name: "RecurringChargeFrequency"))
     RecurringCharge.struct_class = Types::RecurringCharge
@@ -2764,6 +2780,18 @@ module Aws::OpenSearchService
         o.errors << Shapes::ShapeRef.new(shape: DependencyFailureException)
       end)
 
+      api.add_operation(:get_default_application_setting, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "GetDefaultApplicationSetting"
+        o.http_method = "GET"
+        o.http_request_uri = "/2021-01-01/opensearch/defaultApplicationSetting"
+        o.input = Shapes::ShapeRef.new(shape: GetDefaultApplicationSettingRequest)
+        o.output = Shapes::ShapeRef.new(shape: GetDefaultApplicationSettingResponse)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+      end)
+
       api.add_operation(:get_direct_query_data_source, Seahorse::Model::Operation.new.tap do |o|
         o.name = "GetDirectQueryDataSource"
         o.http_method = "GET"
@@ -3071,6 +3099,18 @@ module Aws::OpenSearchService
         o.errors << Shapes::ShapeRef.new(shape: InternalException)
       end)
 
+      api.add_operation(:put_default_application_setting, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "PutDefaultApplicationSetting"
+        o.http_method = "PUT"
+        o.http_request_uri = "/2021-01-01/opensearch/defaultApplicationSetting"
+        o.input = Shapes::ShapeRef.new(shape: PutDefaultApplicationSettingRequest)
+        o.output = Shapes::ShapeRef.new(shape: PutDefaultApplicationSettingResponse)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+      end)
+
       api.add_operation(:reject_inbound_connection, Seahorse::Model::Operation.new.tap do |o|
         o.name = "RejectInboundConnection"
         o.http_method = "PUT"

data/lib/aws-sdk-opensearchservice/types.rb

@@ -368,8 +368,8 @@ module Aws::OpenSearchService
     #   @return [Types::JWTOptionsOutput]
     #
     # @!attribute [rw] iam_federation_options
-    #   Container for information about the IAM federation configuration for
-    #   an OpenSearch UI application.
+    #   Configuration options for IAM identity federation in advanced
+    #   security settings.
     #   @return [Types::IAMFederationOptionsOutput]
     #
     # @!attribute [rw] anonymous_auth_disable_date
@@ -437,8 +437,8 @@ module Aws::OpenSearchService
     #   @return [Types::JWTOptionsInput]
     #
     # @!attribute [rw] iam_federation_options
-    #   Container for information about the IAM federation configuration for
-    #   an OpenSearch UI application.
+    #   Input configuration for IAM identity federation within advanced
+    #   security options.
     #   @return [Types::IAMFederationOptionsInput]
     #
     # @!attribute [rw] anonymous_auth_enabled
@@ -4219,6 +4219,30 @@ module Aws::OpenSearchService
       include Aws::Structure
     end
 
+    # @api private
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetDefaultApplicationSettingRequest AWS API Documentation
+    #
+    class GetDefaultApplicationSettingRequest < Aws::EmptyStructure; end
+
+    # @!attribute [rw] application_arn
+    #   The Amazon Resource Name (ARN) of the domain. See [Identifiers for
+    #   IAM Entities ][1] in *Using Amazon Web Services Identity and Access
+    #   Management* for more information.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetDefaultApplicationSettingResponse AWS API Documentation
+    #
+    class GetDefaultApplicationSettingResponse < Struct.new(
+      :application_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] data_source_name
     #   A unique, user-defined label that identifies the data source within
     #   your OpenSearch Service environment.
@@ -4481,21 +4505,21 @@ module Aws::OpenSearchService
       include Aws::Structure
     end
 
-    # The IAM federation authentication configuration for an Amazon
-    # OpenSearch Service domain.
+    # Input parameters for configuring IAM identity federation settings.
     #
     # @!attribute [rw] enabled
-    #   True to enable IAM federation authentication for a domain.
+    #   Specifies whether IAM identity federation is enabled for the
+    #   OpenSearch domain.
     #   @return [Boolean]
     #
     # @!attribute [rw] subject_key
-    #   Element of the IAM federation assertion to use for the user name.
-    #   Default is `sub`.
+    #   The key in the SAML assertion that contains the user's subject
+    #   identifier.
     #   @return [String]
     #
     # @!attribute [rw] roles_key
-    #   Element of the IAM federation assertion to use for backend roles.
-    #   Default is `roles`.
+    #   The key in the SAML assertion that contains the user's role
+    #   information.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/IAMFederationOptionsInput AWS API Documentation
@@ -4508,18 +4532,22 @@ module Aws::OpenSearchService
       include Aws::Structure
     end
 
-    # Describes the IAM federation options configured for the domain.
+    # Output parameters showing the current IAM identity federation
+    # configuration.
     #
     # @!attribute [rw] enabled
-    #   True if IAM federation is enabled.
+    #   Indicates whether IAM identity federation is currently enabled for
+    #   the domain.
     #   @return [Boolean]
     #
     # @!attribute [rw] subject_key
-    #   The key used for matching the IAM federation subject attribute.
+    #   The configured key in the SAML assertion for the user's subject
+    #   identifier.
     #   @return [String]
     #
     # @!attribute [rw] roles_key
-    #   The key used for matching the IAM federation roles attribute.
+    #   The configured key in the SAML assertion for the user's role
+    #   information.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/IAMFederationOptionsOutput AWS API Documentation
@@ -6435,6 +6463,48 @@ module Aws::OpenSearchService
       include Aws::Structure
     end
 
+    # @!attribute [rw] application_arn
+    #   The Amazon Resource Name (ARN) of the domain. See [Identifiers for
+    #   IAM Entities ][1] in *Using Amazon Web Services Identity and Access
+    #   Management* for more information.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html
+    #   @return [String]
+    #
+    # @!attribute [rw] set_as_default
+    #   Set to true to set the specified ARN as the default application. Set
+    #   to false to clear the default application.
+    #   @return [Boolean]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/PutDefaultApplicationSettingRequest AWS API Documentation
+    #
+    class PutDefaultApplicationSettingRequest < Struct.new(
+      :application_arn,
+      :set_as_default)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] application_arn
+    #   The Amazon Resource Name (ARN) of the domain. See [Identifiers for
+    #   IAM Entities ][1] in *Using Amazon Web Services Identity and Access
+    #   Management* for more information.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/PutDefaultApplicationSettingResponse AWS API Documentation
+    #
+    class PutDefaultApplicationSettingResponse < Struct.new(
+      :application_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Contains the specific price and frequency of a recurring charges for
     # an OpenSearch Reserved Instance, or for a Reserved Instance offering.
     #

data/lib/aws-sdk-opensearchservice.rb

@@ -54,7 +54,7 @@ module Aws::OpenSearchService
   autoload :EndpointProvider, 'aws-sdk-opensearchservice/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-opensearchservice/endpoints'
 
-  GEM_VERSION = '1.77.0'
+  GEM_VERSION = '1.78.0'
 
 end
 

data/sig/client.rbs

@@ -844,6 +844,15 @@ module Aws
                            ) -> _GetDataSourceResponseSuccess
                          | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetDataSourceResponseSuccess
 
+      interface _GetDefaultApplicationSettingResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::GetDefaultApplicationSettingResponse]
+        def application_arn: () -> ::String
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/OpenSearchService/Client.html#get_default_application_setting-instance_method
+      def get_default_application_setting: (
+                                           ) -> _GetDefaultApplicationSettingResponseSuccess
+                                         | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetDefaultApplicationSettingResponseSuccess
+
       interface _GetDirectQueryDataSourceResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::GetDirectQueryDataSourceResponse]
         def data_source_name: () -> ::String
@@ -1097,6 +1106,17 @@ module Aws
                                                ) -> _PurchaseReservedInstanceOfferingResponseSuccess
                                              | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PurchaseReservedInstanceOfferingResponseSuccess
 
+      interface _PutDefaultApplicationSettingResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::PutDefaultApplicationSettingResponse]
+        def application_arn: () -> ::String
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/OpenSearchService/Client.html#put_default_application_setting-instance_method
+      def put_default_application_setting: (
+                                             application_arn: ::String,
+                                             set_as_default: bool
+                                           ) -> _PutDefaultApplicationSettingResponseSuccess
+                                         | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutDefaultApplicationSettingResponseSuccess
+
       interface _RejectInboundConnectionResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::RejectInboundConnectionResponse]
         def connection: () -> Types::InboundConnection

data/sig/types.rbs

@@ -1066,6 +1066,14 @@ module Aws::OpenSearchService
       SENSITIVE: []
     end
 
+    class GetDefaultApplicationSettingRequest < Aws::EmptyStructure
+    end
+
+    class GetDefaultApplicationSettingResponse
+      attr_accessor application_arn: ::String
+      SENSITIVE: []
+    end
+
     class GetDirectQueryDataSourceRequest
       attr_accessor data_source_name: ::String
       SENSITIVE: []
@@ -1637,6 +1645,17 @@ module Aws::OpenSearchService
       SENSITIVE: []
     end
 
+    class PutDefaultApplicationSettingRequest
+      attr_accessor application_arn: ::String
+      attr_accessor set_as_default: bool
+      SENSITIVE: []
+    end
+
+    class PutDefaultApplicationSettingResponse
+      attr_accessor application_arn: ::String
+      SENSITIVE: []
+    end
+
     class RecurringCharge
       attr_accessor recurring_charge_amount: ::Float
       attr_accessor recurring_charge_frequency: ::String

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-opensearchservice
 version: !ruby/object:Gem::Version
-  version: 1.77.0
+  version: 1.78.0
 platform: ruby
 authors:
 - Amazon Web Services