aws-sdk-opensearchservice 1.0.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8be8785ba9f304b323dd7a00b2ec37c3ea2d7980374fd56f38151aedff541776
-  data.tar.gz: 1675763d2da662060814ee6e27769d8d9772edd44277b586f57ddc5ac00cc620
+  metadata.gz: 1b367f578048941d46256fafa0af15b376451efe5582d1234fc74d18cb3b178e
+  data.tar.gz: d16cccc51af8f49afcdf0eb9a87c82b1fc82ff8c8c0c50aaf89d3556f16faaa9
 SHA512:
-  metadata.gz: 68175a4d9d9702cfad2150cfce3d3af0c2a748cfff5522c42cd45b91c6d3793066d1aa0b9ecb5bc504e7a2a67cd5718be7408fba2fb3005fa264f9eb17b367d4
-  data.tar.gz: 01f29bb05c611e67352720608c4b7811dbbba1d3ce5477bb83634e8d0eab9cfb4c5cf2f19af0864ef23804dace498a7cddfe6cf0f054b5c64f29a89e99398ca2
+  metadata.gz: b1aa7e38bd4b857fa49d0396bf4a8200a090299e23aa9d4be86a960cfddf959f1b2c272776be2b991c2d2ec9352dd054e489418054fe2cef011a3879305950dd
+  data.tar.gz: c4228390a44b18dfa47c0ba56dff6fe2d7f388beca0ee20f6b758bc91f37f29cf00e2485420f9560af1ec2c4dd6751cb54dc130ea6f0a9ff985b4be2d5e18ad4

data/CHANGELOG.md

@@ -1,6 +1,26 @@
 Unreleased Changes
 ------------------
 
+1.4.0 (2021-11-23)
+------------------
+
+* Feature - This release adds an optional parameter dry-run for the UpdateDomainConfig API to perform basic validation checks, and detect the deployment type that will be required for the configuration change, without actually applying the change.
+
+1.3.0 (2021-11-04)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.2.0 (2021-10-18)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.1.0 (2021-09-17)
+------------------
+
+* Feature - This release adds an optional parameter in the ListDomainNames API to filter domains based on the engine type (OpenSearch/Elasticsearch).
+
 1.0.0 (2021-09-08)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.4.0

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

@@ -275,6 +275,15 @@ module Aws::OpenSearchService
     #     ** Please note ** When response stubbing is enabled, no HTTP
     #     requests are made, and retries are disabled.
     #
+    #   @option options [Boolean] :use_dualstack_endpoint
+    #     When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
+    #     will be used if available.
+    #
+    #   @option options [Boolean] :use_fips_endpoint
+    #     When set to `true`, fips compatible endpoints will be used if available.
+    #     When a `fips` region is used, the region is normalized and this config
+    #     is set to `true`.
+    #
     #   @option options [Boolean] :validate_params (true)
     #     When `true`, request parameters are validated before
     #     sending the request.
@@ -2065,14 +2074,25 @@ module Aws::OpenSearchService
 
     # Returns the names of all domains owned by the current user's account.
     #
+    # @option params [String] :engine_type
+    #   Optional parameter to filter the output by domain engine type.
+    #   Acceptable values are 'Elasticsearch' and 'OpenSearch'.
+    #
     # @return [Types::ListDomainNamesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::ListDomainNamesResponse#domain_names #domain_names} => Array<Types::DomainInfo>
     #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_domain_names({
+    #     engine_type: "OpenSearch", # accepts OpenSearch, Elasticsearch
+    #   })
+    #
     # @example Response structure
     #
     #   resp.domain_names #=> Array
     #   resp.domain_names[0].domain_name #=> String
+    #   resp.domain_names[0].engine_type #=> String, one of "OpenSearch", "Elasticsearch"
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDomainNames AWS API Documentation
     #
@@ -2521,9 +2541,15 @@ module Aws::OpenSearchService
     # @option params [Types::AutoTuneOptions] :auto_tune_options
     #   Specifies Auto-Tune options.
     #
+    # @option params [Boolean] :dry_run
+    #   This flag, when set to True, specifies whether the `UpdateDomain`
+    #   request should return the results of validation checks (DryRunResults)
+    #   without actually applying the change.
+    #
     # @return [Types::UpdateDomainConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::UpdateDomainConfigResponse#domain_config #domain_config} => Types::DomainConfig
+    #   * {Types::UpdateDomainConfigResponse#dry_run_results #dry_run_results} => Types::DryRunResults
     #
     # @example Request syntax with placeholder values
     #
@@ -2624,6 +2650,7 @@ module Aws::OpenSearchService
     #         },
     #       ],
     #     },
+    #     dry_run: false,
     #   })
     #
     # @example Response structure
@@ -2756,6 +2783,8 @@ module Aws::OpenSearchService
     #   resp.domain_config.auto_tune_options.status.state #=> String, one of "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS", "DISABLED_AND_ROLLBACK_SCHEDULED", "DISABLED_AND_ROLLBACK_IN_PROGRESS", "DISABLED_AND_ROLLBACK_COMPLETE", "DISABLED_AND_ROLLBACK_ERROR", "ERROR"
     #   resp.domain_config.auto_tune_options.status.error_message #=> String
     #   resp.domain_config.auto_tune_options.status.pending_deletion #=> Boolean
+    #   resp.dry_run_results.deployment_type #=> String
+    #   resp.dry_run_results.message #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateDomainConfig AWS API Documentation
     #
@@ -2905,7 +2934,7 @@ module Aws::OpenSearchService
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-opensearchservice'
-      context[:gem_version] = '1.0.0'
+      context[:gem_version] = '1.4.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -78,6 +78,7 @@ module Aws::OpenSearchService
     DeletePackageResponse = Shapes::StructureShape.new(name: 'DeletePackageResponse')
     DeploymentCloseDateTimeStamp = Shapes::TimestampShape.new(name: 'DeploymentCloseDateTimeStamp')
     DeploymentStatus = Shapes::StringShape.new(name: 'DeploymentStatus')
+    DeploymentType = Shapes::StringShape.new(name: 'DeploymentType')
     DescribeDomainAutoTunesRequest = Shapes::StructureShape.new(name: 'DescribeDomainAutoTunesRequest')
     DescribeDomainAutoTunesResponse = Shapes::StructureShape.new(name: 'DescribeDomainAutoTunesResponse')
     DescribeDomainConfigRequest = Shapes::StructureShape.new(name: 'DescribeDomainConfigRequest')
@@ -122,6 +123,8 @@ module Aws::OpenSearchService
     DomainStatus = Shapes::StructureShape.new(name: 'DomainStatus')
     DomainStatusList = Shapes::ListShape.new(name: 'DomainStatusList')
     Double = Shapes::FloatShape.new(name: 'Double')
+    DryRun = Shapes::BooleanShape.new(name: 'DryRun')
+    DryRunResults = Shapes::StructureShape.new(name: 'DryRunResults')
     Duration = Shapes::StructureShape.new(name: 'Duration')
     DurationValue = Shapes::IntegerShape.new(name: 'DurationValue')
     EBSOptions = Shapes::StructureShape.new(name: 'EBSOptions')
@@ -129,6 +132,7 @@ module Aws::OpenSearchService
     EncryptionAtRestOptions = Shapes::StructureShape.new(name: 'EncryptionAtRestOptions')
     EncryptionAtRestOptionsStatus = Shapes::StructureShape.new(name: 'EncryptionAtRestOptionsStatus')
     EndpointsMap = Shapes::MapShape.new(name: 'EndpointsMap')
+    EngineType = Shapes::StringShape.new(name: 'EngineType')
     ErrorDetails = Shapes::StructureShape.new(name: 'ErrorDetails')
     ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
     ErrorType = Shapes::StringShape.new(name: 'ErrorType')
@@ -170,6 +174,7 @@ module Aws::OpenSearchService
     LimitValueList = Shapes::ListShape.new(name: 'LimitValueList')
     Limits = Shapes::StructureShape.new(name: 'Limits')
     LimitsByRole = Shapes::MapShape.new(name: 'LimitsByRole')
+    ListDomainNamesRequest = Shapes::StructureShape.new(name: 'ListDomainNamesRequest')
     ListDomainNamesResponse = Shapes::StructureShape.new(name: 'ListDomainNamesResponse')
     ListDomainsForPackageRequest = Shapes::StructureShape.new(name: 'ListDomainsForPackageRequest')
     ListDomainsForPackageResponse = Shapes::StructureShape.new(name: 'ListDomainsForPackageResponse')
@@ -189,6 +194,7 @@ module Aws::OpenSearchService
     MasterUserOptions = Shapes::StructureShape.new(name: 'MasterUserOptions')
     MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
     MaximumInstanceCount = Shapes::IntegerShape.new(name: 'MaximumInstanceCount')
+    Message = Shapes::StringShape.new(name: 'Message')
     MinimumInstanceCount = Shapes::IntegerShape.new(name: 'MinimumInstanceCount')
     NextToken = Shapes::StringShape.new(name: 'NextToken')
     NodeToNodeEncryptionOptions = Shapes::StructureShape.new(name: 'NodeToNodeEncryptionOptions')
@@ -631,6 +637,7 @@ module Aws::OpenSearchService
     DomainEndpointOptionsStatus.struct_class = Types::DomainEndpointOptionsStatus
 
     DomainInfo.add_member(:domain_name, Shapes::ShapeRef.new(shape: DomainName, location_name: "DomainName"))
+    DomainInfo.add_member(:engine_type, Shapes::ShapeRef.new(shape: EngineType, location_name: "EngineType"))
     DomainInfo.struct_class = Types::DomainInfo
 
     DomainInfoList.member = Shapes::ShapeRef.new(shape: DomainInfo)
@@ -681,6 +688,10 @@ module Aws::OpenSearchService
 
     DomainStatusList.member = Shapes::ShapeRef.new(shape: DomainStatus)
 
+    DryRunResults.add_member(:deployment_type, Shapes::ShapeRef.new(shape: DeploymentType, location_name: "DeploymentType"))
+    DryRunResults.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
+    DryRunResults.struct_class = Types::DryRunResults
+
     Duration.add_member(:value, Shapes::ShapeRef.new(shape: DurationValue, location_name: "Value"))
     Duration.add_member(:unit, Shapes::ShapeRef.new(shape: TimeUnit, location_name: "Unit"))
     Duration.struct_class = Types::Duration
@@ -801,6 +812,9 @@ module Aws::OpenSearchService
     LimitsByRole.key = Shapes::ShapeRef.new(shape: InstanceRole)
     LimitsByRole.value = Shapes::ShapeRef.new(shape: Limits)
 
+    ListDomainNamesRequest.add_member(:engine_type, Shapes::ShapeRef.new(shape: EngineType, location: "querystring", location_name: "engineType"))
+    ListDomainNamesRequest.struct_class = Types::ListDomainNamesRequest
+
     ListDomainNamesResponse.add_member(:domain_names, Shapes::ShapeRef.new(shape: DomainInfoList, location_name: "DomainNames"))
     ListDomainNamesResponse.struct_class = Types::ListDomainNamesResponse
 
@@ -1056,9 +1070,11 @@ module Aws::OpenSearchService
     UpdateDomainConfigRequest.add_member(:node_to_node_encryption_options, Shapes::ShapeRef.new(shape: NodeToNodeEncryptionOptions, location_name: "NodeToNodeEncryptionOptions"))
     UpdateDomainConfigRequest.add_member(:advanced_security_options, Shapes::ShapeRef.new(shape: AdvancedSecurityOptionsInput, location_name: "AdvancedSecurityOptions"))
     UpdateDomainConfigRequest.add_member(:auto_tune_options, Shapes::ShapeRef.new(shape: AutoTuneOptions, location_name: "AutoTuneOptions"))
+    UpdateDomainConfigRequest.add_member(:dry_run, Shapes::ShapeRef.new(shape: DryRun, location_name: "DryRun"))
     UpdateDomainConfigRequest.struct_class = Types::UpdateDomainConfigRequest
 
     UpdateDomainConfigResponse.add_member(:domain_config, Shapes::ShapeRef.new(shape: DomainConfig, required: true, location_name: "DomainConfig"))
+    UpdateDomainConfigResponse.add_member(:dry_run_results, Shapes::ShapeRef.new(shape: DryRunResults, location_name: "DryRunResults"))
     UpdateDomainConfigResponse.struct_class = Types::UpdateDomainConfigResponse
 
     UpdatePackageRequest.add_member(:package_id, Shapes::ShapeRef.new(shape: PackageID, required: true, location_name: "PackageID"))
@@ -1515,7 +1531,7 @@ module Aws::OpenSearchService
         o.name = "ListDomainNames"
         o.http_method = "GET"
         o.http_request_uri = "/2021-01-01/domain"
-        o.input = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
+        o.input = Shapes::ShapeRef.new(shape: ListDomainNamesRequest)
         o.output = Shapes::ShapeRef.new(shape: ListDomainNamesResponse)
         o.errors << Shapes::ShapeRef.new(shape: BaseException)
         o.errors << Shapes::ShapeRef.new(shape: ValidationException)

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

@@ -753,6 +753,7 @@ module Aws::OpenSearchService
     #   @return [Integer]
     #
     # @!attribute [rw] cold_storage_options
+    #   Specifies the `ColdStorageOptions` config for a Domain
     #   @return [Types::ColdStorageOptions]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ClusterConfig AWS API Documentation
@@ -859,6 +860,8 @@ module Aws::OpenSearchService
       include Aws::Structure
     end
 
+    # Specifies the configuration for cold storage options such as enabled
+    #
     # @note When making an API call, you may pass ColdStorageOptions
     #   data as a hash:
     #
@@ -867,6 +870,7 @@ module Aws::OpenSearchService
     #       }
     #
     # @!attribute [rw] enabled
+    #   Enable cold storage option. Accepted values true or false
     #   @return [Boolean]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ColdStorageOptions AWS API Documentation
@@ -2236,10 +2240,15 @@ module Aws::OpenSearchService
     #   The `DomainName`.
     #   @return [String]
     #
+    # @!attribute [rw] engine_type
+    #   Specifies the `EngineType` of the domain.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DomainInfo AWS API Documentation
     #
     class DomainInfo < Struct.new(
-      :domain_name)
+      :domain_name,
+      :engine_type)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -2482,6 +2491,29 @@ module Aws::OpenSearchService
       include Aws::Structure
     end
 
+    # @!attribute [rw] deployment_type
+    #   Specifies the way in which Amazon OpenSearch Service applies the
+    #   update. Possible responses are `Blue/Green` (the update requires a
+    #   blue/green deployment), `DynamicUpdate` (no blue/green required),
+    #   `Undetermined` (the domain is undergoing an update and can't
+    #   predict the deployment type; try again after the update is
+    #   complete), and `None` (the request doesn't include any
+    #   configuration changes).
+    #   @return [String]
+    #
+    # @!attribute [rw] message
+    #   Contains an optional message associated with the DryRunResults.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DryRunResults AWS API Documentation
+    #
+    class DryRunResults < Struct.new(
+      :deployment_type,
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The maintenance schedule duration: duration value and duration unit.
     # See [ Auto-Tune for Amazon OpenSearch Service ][1] for more
     # information.
@@ -3090,11 +3122,33 @@ module Aws::OpenSearchService
       include Aws::Structure
     end
 
+    # Container for the parameters to the `ListDomainNames` operation.
+    #
+    # @note When making an API call, you may pass ListDomainNamesRequest
+    #   data as a hash:
+    #
+    #       {
+    #         engine_type: "OpenSearch", # accepts OpenSearch, Elasticsearch
+    #       }
+    #
+    # @!attribute [rw] engine_type
+    #   Optional parameter to filter the output by domain engine type.
+    #   Acceptable values are 'Elasticsearch' and 'OpenSearch'.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDomainNamesRequest AWS API Documentation
+    #
+    class ListDomainNamesRequest < Struct.new(
+      :engine_type)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The result of a `ListDomainNames` operation. Contains the names of all
-    # domains owned by this account.
+    # domains owned by this account and their respective engine types.
     #
     # @!attribute [rw] domain_names
-    #   List of domain names.
+    #   List of domain names and respective engine types.
     #   @return [Array<Types::DomainInfo>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDomainNamesResponse AWS API Documentation
@@ -4498,6 +4552,7 @@ module Aws::OpenSearchService
     #             },
     #           ],
     #         },
+    #         dry_run: false,
     #       }
     #
     # @!attribute [rw] domain_name
@@ -4580,6 +4635,12 @@ module Aws::OpenSearchService
     #   Specifies Auto-Tune options.
     #   @return [Types::AutoTuneOptions]
     #
+    # @!attribute [rw] dry_run
+    #   This flag, when set to True, specifies whether the `UpdateDomain`
+    #   request should return the results of validation checks
+    #   (DryRunResults) without actually applying the change.
+    #   @return [Boolean]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateDomainConfigRequest AWS API Documentation
     #
     class UpdateDomainConfigRequest < Struct.new(
@@ -4596,7 +4657,8 @@ module Aws::OpenSearchService
       :domain_endpoint_options,
       :node_to_node_encryption_options,
       :advanced_security_options,
-      :auto_tune_options)
+      :auto_tune_options,
+      :dry_run)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -4608,10 +4670,15 @@ module Aws::OpenSearchService
     #   The status of the updated domain.
     #   @return [Types::DomainConfig]
     #
+    # @!attribute [rw] dry_run_results
+    #   Contains result of DryRun.
+    #   @return [Types::DryRunResults]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateDomainConfigResponse AWS API Documentation
     #
     class UpdateDomainConfigResponse < Struct.new(
-      :domain_config)
+      :domain_config,
+      :dry_run_results)
       SENSITIVE = []
       include Aws::Structure
     end

data/lib/aws-sdk-opensearchservice.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-opensearchservice/customizations'
 # @!group service
 module Aws::OpenSearchService
 
-  GEM_VERSION = '1.0.0'
+  GEM_VERSION = '1.4.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-opensearchservice
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-08 00:00:00.000000000 Z
+date: 2021-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.120.0
+        version: 3.122.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.120.0
+        version: 3.122.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement