aws-sdk-finspace 1.21.0 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6ae6a20b4488b5dfde1d5da80e6883d8c274ea152683ec5a13f82fdd34851e5
-  data.tar.gz: d4440ee58a95142bc40f00d235d2f8fa4dcc6a10e4244f0bc2a13c5338537203
+  metadata.gz: 4c7281f667b62324866fef8eaf0a8a9671f3d81118474256b9d81652ecd348b2
+  data.tar.gz: 9900f8de8320ce9d3ed5335720b059abfeb3011d1e41598f0a65ef55f42de4f1
 SHA512:
-  metadata.gz: 6a3d91da4aaa0927ca0e31fc511f87935fc5d8b19f5f8da0d8f212055ad39519f112b10f94df55e7ce379ae644d60d51571e8bfaf58c431a003e823c75920c08
-  data.tar.gz: b87ac07031f532fae6b7622486d833f4279299929774b51bf1a1d4f55d4fcf8269f68b998648666f41486dc18cc30dfb296c784c71906ab5aa41710a41c93754
+  metadata.gz: 4a65ec9d488be7116e9c57ea72efb5a12f0a5c0d99894eeaf246c4016eccde12bd341ca8d3bb52cf190b44499041f3c4d9980b4a8e987dd5c7afbfcdd6e8e7fb
+  data.tar.gz: dbac9e8c377ca8f38aef47f6403106b8b1259bc1856dc8191497234b6517d13b36d29bf7ab082ab26eb626b0b2fbd41bf36e4a00de3ce9c7a25cab333dedd814

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.23.0 (2023-11-15)
+------------------
+
+* Feature - Adding deprecated trait on Dataset Browser Environment APIs
+
+1.22.0 (2023-10-30)
+------------------
+
+* Feature - Introducing new API UpdateKxClusterCodeConfiguration, introducing new cache types for clusters and introducing new deployment modes for updating clusters.
+
 1.21.0 (2023-09-27)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.21.0
+1.23.0

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

@@ -2073,6 +2073,76 @@ module Aws::Finspace
       req.send_request(options)
     end
 
+    # Allows you to update code configuration on a running cluster. By using
+    # this API you can update the code, the initialization script path, and
+    # the command line arguments for a specific cluster. The configuration
+    # that you want to update will override any existing configurations on
+    # the cluster.
+    #
+    # @option params [required, String] :environment_id
+    #   A unique identifier of the kdb environment.
+    #
+    # @option params [required, String] :cluster_name
+    #   The name of the cluster.
+    #
+    # @option params [String] :client_token
+    #   A token that ensures idempotency. This token expires in 10 minutes.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.**
+    #
+    # @option params [required, Types::CodeConfiguration] :code
+    #   The structure of the customer code available within the running
+    #   cluster.
+    #
+    # @option params [String] :initialization_script
+    #   Specifies a Q program that will be run at launch of a cluster. It is a
+    #   relative path within *.zip* file that contains the custom code, which
+    #   will be loaded on the cluster. It must include the file name itself.
+    #   For example, `somedir/init.q`.
+    #
+    # @option params [Array<Types::KxCommandLineArgument>] :command_line_arguments
+    #   Specifies the key-value pairs to make them available inside the
+    #   cluster.
+    #
+    # @option params [Types::KxClusterCodeDeploymentConfiguration] :deployment_configuration
+    #   The configuration that allows you to choose how you want to update the
+    #   code on a cluster.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.update_kx_cluster_code_configuration({
+    #     environment_id: "KxEnvironmentId", # required
+    #     cluster_name: "KxClusterName", # required
+    #     client_token: "ClientTokenString",
+    #     code: { # required
+    #       s3_bucket: "S3Bucket",
+    #       s3_key: "S3Key",
+    #       s3_object_version: "S3ObjectVersion",
+    #     },
+    #     initialization_script: "InitializationScriptFilePath",
+    #     command_line_arguments: [
+    #       {
+    #         key: "KxCommandLineArgumentKey",
+    #         value: "KxCommandLineArgumentValue",
+    #       },
+    #     ],
+    #     deployment_configuration: {
+    #       deployment_strategy: "ROLLING", # required, accepts ROLLING, FORCE
+    #     },
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxClusterCodeConfiguration AWS API Documentation
+    #
+    # @overload update_kx_cluster_code_configuration(params = {})
+    # @param [Hash] params ({})
+    def update_kx_cluster_code_configuration(params = {}, options = {})
+      req = build_request(:update_kx_cluster_code_configuration, params)
+      req.send_request(options)
+    end
+
     # Updates the databases mounted on a kdb cluster, which includes the
     # `changesetId` and all the dbPaths to be cached. This API does not
     # allow you to change a database name or add a database if you created a
@@ -2442,7 +2512,7 @@ module Aws::Finspace
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-finspace'
-      context[:gem_version] = '1.21.0'
+      context[:gem_version] = '1.23.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -112,6 +112,8 @@ module Aws::Finspace
     KxChangesetListEntry = Shapes::StructureShape.new(name: 'KxChangesetListEntry')
     KxChangesets = Shapes::ListShape.new(name: 'KxChangesets')
     KxCluster = Shapes::StructureShape.new(name: 'KxCluster')
+    KxClusterCodeDeploymentConfiguration = Shapes::StructureShape.new(name: 'KxClusterCodeDeploymentConfiguration')
+    KxClusterCodeDeploymentStrategy = Shapes::StringShape.new(name: 'KxClusterCodeDeploymentStrategy')
     KxClusterDescription = Shapes::StringShape.new(name: 'KxClusterDescription')
     KxClusterName = Shapes::StringShape.new(name: 'KxClusterName')
     KxClusterNodeIdString = Shapes::StringShape.new(name: 'KxClusterNodeIdString')
@@ -205,6 +207,8 @@ module Aws::Finspace
     UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
     UpdateEnvironmentRequest = Shapes::StructureShape.new(name: 'UpdateEnvironmentRequest')
     UpdateEnvironmentResponse = Shapes::StructureShape.new(name: 'UpdateEnvironmentResponse')
+    UpdateKxClusterCodeConfigurationRequest = Shapes::StructureShape.new(name: 'UpdateKxClusterCodeConfigurationRequest')
+    UpdateKxClusterCodeConfigurationResponse = Shapes::StructureShape.new(name: 'UpdateKxClusterCodeConfigurationResponse')
     UpdateKxClusterDatabasesRequest = Shapes::StructureShape.new(name: 'UpdateKxClusterDatabasesRequest')
     UpdateKxClusterDatabasesResponse = Shapes::StructureShape.new(name: 'UpdateKxClusterDatabasesResponse')
     UpdateKxDatabaseRequest = Shapes::StructureShape.new(name: 'UpdateKxDatabaseRequest')
@@ -598,6 +602,9 @@ module Aws::Finspace
     KxCluster.add_member(:created_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "createdTimestamp"))
     KxCluster.struct_class = Types::KxCluster
 
+    KxClusterCodeDeploymentConfiguration.add_member(:deployment_strategy, Shapes::ShapeRef.new(shape: KxClusterCodeDeploymentStrategy, required: true, location_name: "deploymentStrategy"))
+    KxClusterCodeDeploymentConfiguration.struct_class = Types::KxClusterCodeDeploymentConfiguration
+
     KxClusters.member = Shapes::ShapeRef.new(shape: KxCluster)
 
     KxCommandLineArgument.add_member(:key, Shapes::ShapeRef.new(shape: KxCommandLineArgumentKey, location_name: "key"))
@@ -810,6 +817,17 @@ module Aws::Finspace
     UpdateEnvironmentResponse.add_member(:environment, Shapes::ShapeRef.new(shape: Environment, location_name: "environment"))
     UpdateEnvironmentResponse.struct_class = Types::UpdateEnvironmentResponse
 
+    UpdateKxClusterCodeConfigurationRequest.add_member(:environment_id, Shapes::ShapeRef.new(shape: KxEnvironmentId, required: true, location: "uri", location_name: "environmentId"))
+    UpdateKxClusterCodeConfigurationRequest.add_member(:cluster_name, Shapes::ShapeRef.new(shape: KxClusterName, required: true, location: "uri", location_name: "clusterName"))
+    UpdateKxClusterCodeConfigurationRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientTokenString, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))
+    UpdateKxClusterCodeConfigurationRequest.add_member(:code, Shapes::ShapeRef.new(shape: CodeConfiguration, required: true, location_name: "code"))
+    UpdateKxClusterCodeConfigurationRequest.add_member(:initialization_script, Shapes::ShapeRef.new(shape: InitializationScriptFilePath, location_name: "initializationScript"))
+    UpdateKxClusterCodeConfigurationRequest.add_member(:command_line_arguments, Shapes::ShapeRef.new(shape: KxCommandLineArguments, location_name: "commandLineArguments"))
+    UpdateKxClusterCodeConfigurationRequest.add_member(:deployment_configuration, Shapes::ShapeRef.new(shape: KxClusterCodeDeploymentConfiguration, location_name: "deploymentConfiguration"))
+    UpdateKxClusterCodeConfigurationRequest.struct_class = Types::UpdateKxClusterCodeConfigurationRequest
+
+    UpdateKxClusterCodeConfigurationResponse.struct_class = Types::UpdateKxClusterCodeConfigurationResponse
+
     UpdateKxClusterDatabasesRequest.add_member(:environment_id, Shapes::ShapeRef.new(shape: KxEnvironmentId, required: true, location: "uri", location_name: "environmentId"))
     UpdateKxClusterDatabasesRequest.add_member(:cluster_name, Shapes::ShapeRef.new(shape: KxClusterName, required: true, location: "uri", location_name: "clusterName"))
     UpdateKxClusterDatabasesRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientTokenString, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))
@@ -923,6 +941,7 @@ module Aws::Finspace
         o.name = "CreateEnvironment"
         o.http_method = "POST"
         o.http_request_uri = "/environment"
+        o.deprecated = true
         o.input = Shapes::ShapeRef.new(shape: CreateEnvironmentRequest)
         o.output = Shapes::ShapeRef.new(shape: CreateEnvironmentResponse)
         o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
@@ -1015,6 +1034,7 @@ module Aws::Finspace
         o.name = "DeleteEnvironment"
         o.http_method = "DELETE"
         o.http_request_uri = "/environment/{environmentId}"
+        o.deprecated = true
         o.input = Shapes::ShapeRef.new(shape: DeleteEnvironmentRequest)
         o.output = Shapes::ShapeRef.new(shape: DeleteEnvironmentResponse)
         o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
@@ -1083,6 +1103,7 @@ module Aws::Finspace
         o.name = "GetEnvironment"
         o.http_method = "GET"
         o.http_request_uri = "/environment/{environmentId}"
+        o.deprecated = true
         o.input = Shapes::ShapeRef.new(shape: GetEnvironmentRequest)
         o.output = Shapes::ShapeRef.new(shape: GetEnvironmentResponse)
         o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
@@ -1174,6 +1195,7 @@ module Aws::Finspace
         o.name = "ListEnvironments"
         o.http_method = "GET"
         o.http_request_uri = "/environment"
+        o.deprecated = true
         o.input = Shapes::ShapeRef.new(shape: ListEnvironmentsRequest)
         o.output = Shapes::ShapeRef.new(shape: ListEnvironmentsResponse)
         o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
@@ -1319,6 +1341,7 @@ module Aws::Finspace
         o.name = "UpdateEnvironment"
         o.http_method = "PUT"
         o.http_request_uri = "/environment/{environmentId}"
+        o.deprecated = true
         o.input = Shapes::ShapeRef.new(shape: UpdateEnvironmentRequest)
         o.output = Shapes::ShapeRef.new(shape: UpdateEnvironmentResponse)
         o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
@@ -1328,6 +1351,21 @@ module Aws::Finspace
         o.errors << Shapes::ShapeRef.new(shape: ValidationException)
       end)
 
+      api.add_operation(:update_kx_cluster_code_configuration, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "UpdateKxClusterCodeConfiguration"
+        o.http_method = "PUT"
+        o.http_request_uri = "/kx/environments/{environmentId}/clusters/{clusterName}/configuration/code"
+        o.input = Shapes::ShapeRef.new(shape: UpdateKxClusterCodeConfigurationRequest)
+        o.output = Shapes::ShapeRef.new(shape: UpdateKxClusterCodeConfigurationResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: ConflictException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+      end)
+
       api.add_operation(:update_kx_cluster_databases, Seahorse::Model::Operation.new.tap do |o|
         o.name = "UpdateKxClusterDatabases"
         o.http_method = "PUT"

data/lib/aws-sdk-finspace/endpoint_provider.rb

@@ -32,7 +32,7 @@ module Aws::Finspace
             raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
           end
           if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
-            if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
+            if Aws::Endpoints::Matchers.boolean_equals?(Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"), true)
               return Aws::Endpoints::Endpoint.new(url: "https://finspace-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
             end
             raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"

data/lib/aws-sdk-finspace/endpoints.rb

@@ -418,6 +418,20 @@ module Aws::Finspace
       end
     end
 
+    class UpdateKxClusterCodeConfiguration
+      def self.build(context)
+        unless context.config.regional_endpoint
+          endpoint = context.config.endpoint.to_s
+        end
+        Aws::Finspace::EndpointParameters.new(
+          region: context.config.region,
+          use_dual_stack: context.config.use_dualstack_endpoint,
+          use_fips: context.config.use_fips_endpoint,
+          endpoint: endpoint,
+        )
+      end
+    end
+
     class UpdateKxClusterDatabases
       def self.build(context)
         unless context.config.regional_endpoint

data/lib/aws-sdk-finspace/plugins/endpoints.rb

@@ -114,6 +114,8 @@ module Aws::Finspace
             Aws::Finspace::Endpoints::UntagResource.build(context)
           when :update_environment
             Aws::Finspace::Endpoints::UpdateEnvironment.build(context)
+          when :update_kx_cluster_code_configuration
+            Aws::Finspace::Endpoints::UpdateKxClusterCodeConfiguration.build(context)
           when :update_kx_cluster_databases
             Aws::Finspace::Endpoints::UpdateKxClusterDatabases.build(context)
           when :update_kx_database

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

@@ -1842,12 +1842,20 @@ module Aws::Finspace
     # The configuration for read only disk cache associated with a cluster.
     #
     # @!attribute [rw] type
-    #   The type of cache storage . The valid values are:
+    #   The type of cache storage. The valid values are:
     #
     #   * CACHE\_1000 – This type provides at least 1000 MB/s disk access
     #     throughput.
     #
-    #   ^
+    #   * CACHE\_250 – This type provides at least 250 MB/s disk access
+    #     throughput.
+    #
+    #   * CACHE\_12 – This type provides at least 12 MB/s disk access
+    #     throughput.
+    #
+    #   For cache type `CACHE_1000` and `CACHE_250` you can select cache
+    #   size as 1200 GB or increments of 2400 GB. For cache type `CACHE_12`
+    #   you can select the cache size in increments of 6000 GB.
     #   @return [String]
     #
     # @!attribute [rw] size
@@ -2032,6 +2040,29 @@ module Aws::Finspace
       include Aws::Structure
     end
 
+    # The configuration that allows you to choose how you want to update
+    # code on a cluster. Depending on the option you choose, you can reduce
+    # the time it takes to update the cluster.
+    #
+    # @!attribute [rw] deployment_strategy
+    #   The type of deployment that you want on a cluster.
+    #
+    #   * ROLLING – This options updates the cluster by stopping the exiting
+    #     q process and starting a new q process with updated configuration.
+    #
+    #   * FORCE – This option updates the cluster by immediately stopping
+    #     all the running processes before starting up new ones with the
+    #     updated configuration.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/KxClusterCodeDeploymentConfiguration AWS API Documentation
+    #
+    class KxClusterCodeDeploymentConfiguration < Struct.new(
+      :deployment_strategy)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Defines the key-value pairs to make them available inside the cluster.
     #
     # @!attribute [rw] key
@@ -2138,20 +2169,21 @@ module Aws::Finspace
 
     # The configuration that allows you to choose how you want to update the
     # databases on a cluster. Depending on the option you choose, you can
-    # reduce the time it takes to update the database changesets on to a
-    # cluster.
+    # reduce the time it takes to update the cluster.
     #
     # @!attribute [rw] deployment_strategy
     #   The type of deployment that you want on a cluster.
     #
-    #   * ROLLING – This options loads the updated database by stopping the
-    #     exiting q process and starting a new q process with updated
-    #     configuration.
+    #   * ROLLING – This options updates the cluster by stopping the exiting
+    #     q process and starting a new q process with updated configuration.
     #
-    #   * NO\_RESTART – This option loads the updated database on the
-    #     running q process without stopping it. This option is quicker as
-    #     it reduces the turn around time to update a kdb database changeset
-    #     configuration on a cluster.
+    #   * NO\_RESTART – This option updates the cluster without stopping the
+    #     running q process. It is only available for `HDB` type cluster.
+    #     This option is quicker as it reduces the turn around time to
+    #     update configuration on a cluster.
+    #
+    #     With this deployment mode, you cannot update the
+    #     `initializationScript` and `commandLineArguments` parameters.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/KxDeploymentConfiguration AWS API Documentation
@@ -2985,6 +3017,61 @@ module Aws::Finspace
       include Aws::Structure
     end
 
+    # @!attribute [rw] environment_id
+    #   A unique identifier of the kdb environment.
+    #   @return [String]
+    #
+    # @!attribute [rw] cluster_name
+    #   The name of the cluster.
+    #   @return [String]
+    #
+    # @!attribute [rw] client_token
+    #   A token that ensures idempotency. This token expires in 10 minutes.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.
+    #   @return [String]
+    #
+    # @!attribute [rw] code
+    #   The structure of the customer code available within the running
+    #   cluster.
+    #   @return [Types::CodeConfiguration]
+    #
+    # @!attribute [rw] initialization_script
+    #   Specifies a Q program that will be run at launch of a cluster. It is
+    #   a relative path within *.zip* file that contains the custom code,
+    #   which will be loaded on the cluster. It must include the file name
+    #   itself. For example, `somedir/init.q`.
+    #   @return [String]
+    #
+    # @!attribute [rw] command_line_arguments
+    #   Specifies the key-value pairs to make them available inside the
+    #   cluster.
+    #   @return [Array<Types::KxCommandLineArgument>]
+    #
+    # @!attribute [rw] deployment_configuration
+    #   The configuration that allows you to choose how you want to update
+    #   the code on a cluster.
+    #   @return [Types::KxClusterCodeDeploymentConfiguration]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxClusterCodeConfigurationRequest AWS API Documentation
+    #
+    class UpdateKxClusterCodeConfigurationRequest < Struct.new(
+      :environment_id,
+      :cluster_name,
+      :client_token,
+      :code,
+      :initialization_script,
+      :command_line_arguments,
+      :deployment_configuration)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxClusterCodeConfigurationResponse AWS API Documentation
+    #
+    class UpdateKxClusterCodeConfigurationResponse < Aws::EmptyStructure; end
+
     # @!attribute [rw] environment_id
     #   The unique identifier of a kdb environment.
     #   @return [String]

data/lib/aws-sdk-finspace.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-finspace/customizations'
 # @!group service
 module Aws::Finspace
 
-  GEM_VERSION = '1.21.0'
+  GEM_VERSION = '1.23.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-finspace
 version: !ruby/object:Gem::Version
-  version: 1.21.0
+  version: 1.23.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-27 00:00:00.000000000 Z
+date: 2023-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core