aws-sdk-finspace 1.13.0 → 1.15.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -277,6 +277,11 @@ module Aws::Finspace
277
277
  # in the future.
278
278
  #
279
279
  #
280
+ # @option options [String] :sdk_ua_app_id
281
+ # A unique and opaque application ID that is appended to the
282
+ # User-Agent header as app/<sdk_ua_app_id>. It should have a
283
+ # maximum length of 50.
284
+ #
280
285
  # @option options [String] :secret_access_key
281
286
  #
282
287
  # @option options [String] :session_token
@@ -433,7 +438,7 @@ module Aws::Finspace
433
438
  # federation_urn: "urn",
434
439
  # federation_provider_name: "FederationProviderName",
435
440
  # attribute_map: {
436
- # "FederationAttributeKey" => "url",
441
+ # "FederationAttributeKey" => "FederationAttributeValue",
437
442
  # },
438
443
  # },
439
444
  # superuser_parameters: {
@@ -459,266 +464,1558 @@ module Aws::Finspace
459
464
  req.send_request(options)
460
465
  end
461
466
 
462
- # Delete an FinSpace environment.
467
+ # Creates a changeset for a kdb database. A changeset allows you to add
468
+ # and delete existing files by using an ordered list of change requests.
463
469
  #
464
470
  # @option params [required, String] :environment_id
465
- # The identifier for the FinSpace environment.
471
+ # A unique identifier of the kdb environment.
466
472
  #
467
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
473
+ # @option params [required, String] :database_name
474
+ # The name of the kdb database.
475
+ #
476
+ # @option params [required, Array<Types::ChangeRequest>] :change_requests
477
+ # A list of change request objects that are run in order. A change
478
+ # request object consists of changeType , s3Path, and a dbPath. A
479
+ # changeType can has the following values:
480
+ #
481
+ # * PUT – Adds or updates files in a database.
482
+ #
483
+ # * DELETE – Deletes files in a database.
484
+ #
485
+ # All the change requests require a mandatory *dbPath* attribute that
486
+ # defines the path within the database directory. The *s3Path* attribute
487
+ # defines the s3 source file path and is required for a PUT change type.
488
+ #
489
+ # Here is an example of how you can use the change request object:
490
+ #
491
+ # `[ \{ "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/",
492
+ # "dbPath":"/2020.01.02/"\}, \{ "changeType": "PUT",
493
+ # "s3Path":"s3://bucket/db/sym", "dbPath":"/"\}, \{ "changeType":
494
+ # "DELETE", "dbPath": "/2020.01.01/"\} ]`
495
+ #
496
+ # In this example, the first request with *PUT* change type allows you
497
+ # to add files in the given s3Path under the *2020.01.02* partition of
498
+ # the database. The second request with *PUT* change type allows you to
499
+ # add a single sym file at database root location. The last request with
500
+ # *DELETE* change type allows you to delete the files under the
501
+ # *2020.01.01* partition of the database.
502
+ #
503
+ # @option params [required, String] :client_token
504
+ # A token that ensures idempotency. This token expires in 10 minutes.
505
+ #
506
+ # **A suitable default value is auto-generated.** You should normally
507
+ # not need to pass this option.**
508
+ #
509
+ # @return [Types::CreateKxChangesetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
510
+ #
511
+ # * {Types::CreateKxChangesetResponse#changeset_id #changeset_id} => String
512
+ # * {Types::CreateKxChangesetResponse#database_name #database_name} => String
513
+ # * {Types::CreateKxChangesetResponse#environment_id #environment_id} => String
514
+ # * {Types::CreateKxChangesetResponse#change_requests #change_requests} => Array&lt;Types::ChangeRequest&gt;
515
+ # * {Types::CreateKxChangesetResponse#created_timestamp #created_timestamp} => Time
516
+ # * {Types::CreateKxChangesetResponse#last_modified_timestamp #last_modified_timestamp} => Time
517
+ # * {Types::CreateKxChangesetResponse#status #status} => String
518
+ # * {Types::CreateKxChangesetResponse#error_info #error_info} => Types::ErrorInfo
468
519
  #
469
520
  # @example Request syntax with placeholder values
470
521
  #
471
- # resp = client.delete_environment({
472
- # environment_id: "IdType", # required
522
+ # resp = client.create_kx_changeset({
523
+ # environment_id: "EnvironmentId", # required
524
+ # database_name: "DatabaseName", # required
525
+ # change_requests: [ # required
526
+ # {
527
+ # change_type: "PUT", # required, accepts PUT, DELETE
528
+ # s3_path: "S3Path",
529
+ # db_path: "DbPath", # required
530
+ # },
531
+ # ],
532
+ # client_token: "ClientTokenString", # required
473
533
  # })
474
534
  #
475
- # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteEnvironment AWS API Documentation
535
+ # @example Response structure
476
536
  #
477
- # @overload delete_environment(params = {})
537
+ # resp.changeset_id #=> String
538
+ # resp.database_name #=> String
539
+ # resp.environment_id #=> String
540
+ # resp.change_requests #=> Array
541
+ # resp.change_requests[0].change_type #=> String, one of "PUT", "DELETE"
542
+ # resp.change_requests[0].s3_path #=> String
543
+ # resp.change_requests[0].db_path #=> String
544
+ # resp.created_timestamp #=> Time
545
+ # resp.last_modified_timestamp #=> Time
546
+ # resp.status #=> String, one of "PENDING", "PROCESSING", "FAILED", "COMPLETED"
547
+ # resp.error_info.error_message #=> String
548
+ # resp.error_info.error_type #=> String, one of "The inputs to this request are invalid.", "Service limits have been exceeded.", "Missing required permission to perform this request.", "One or more inputs to this request were not found.", "The system temporarily lacks sufficient resources to process the request.", "An internal error has occurred.", "Cancelled", "A user recoverable error has occurred"
549
+ #
550
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxChangeset AWS API Documentation
551
+ #
552
+ # @overload create_kx_changeset(params = {})
478
553
  # @param [Hash] params ({})
479
- def delete_environment(params = {}, options = {})
480
- req = build_request(:delete_environment, params)
554
+ def create_kx_changeset(params = {}, options = {})
555
+ req = build_request(:create_kx_changeset, params)
481
556
  req.send_request(options)
482
557
  end
483
558
 
484
- # Returns the FinSpace environment object.
559
+ # Creates a new kdb cluster.
560
+ #
561
+ # @option params [String] :client_token
562
+ # A token that ensures idempotency. This token expires in 10 minutes.
563
+ #
564
+ # **A suitable default value is auto-generated.** You should normally
565
+ # not need to pass this option.**
485
566
  #
486
567
  # @option params [required, String] :environment_id
487
- # The identifier of the FinSpace environment.
568
+ # A unique identifier for the kdb environment.
488
569
  #
489
- # @return [Types::GetEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
570
+ # @option params [required, String] :cluster_name
571
+ # A unique name for the cluster that you want to create.
490
572
  #
491
- # * {Types::GetEnvironmentResponse#environment #environment} => Types::Environment
573
+ # @option params [required, String] :cluster_type
574
+ # Specifies the type of KDB database that is being created. The
575
+ # following types are available:
576
+ #
577
+ # * HDB – A Historical Database. The data is only accessible with
578
+ # read-only permissions from one of the FinSpace managed kdb databases
579
+ # mounted to the cluster.
580
+ #
581
+ # * RDB – A Realtime Database. This type of database captures all the
582
+ # data from a ticker plant and stores it in memory until the end of
583
+ # day, after which it writes all of its data to a disk and reloads the
584
+ # HDB. This cluster type requires local storage for temporary storage
585
+ # of data during the savedown process. If you specify this field in
586
+ # your request, you must provide the `savedownStorageConfiguration`
587
+ # parameter.
588
+ #
589
+ # * GATEWAY – A gateway cluster allows you to access data across
590
+ # processes in kdb systems. It allows you to create your own routing
591
+ # logic using the initialization scripts and custom code. This type of
592
+ # cluster does not require a writable local storage.
593
+ #
594
+ # @option params [Array<Types::KxDatabaseConfiguration>] :databases
595
+ # A list of databases that will be available for querying.
596
+ #
597
+ # @option params [Array<Types::KxCacheStorageConfiguration>] :cache_storage_configurations
598
+ # The configurations for a read only cache storage associated with a
599
+ # cluster. This cache will be stored as an FSx Lustre that reads from
600
+ # the S3 store.
601
+ #
602
+ # @option params [Types::AutoScalingConfiguration] :auto_scaling_configuration
603
+ # The configuration based on which FinSpace will scale in or scale out
604
+ # nodes in your cluster.
605
+ #
606
+ # @option params [String] :cluster_description
607
+ # A description of the cluster.
608
+ #
609
+ # @option params [required, Types::CapacityConfiguration] :capacity_configuration
610
+ # A structure for the metadata of a cluster. It includes information
611
+ # about like the CPUs needed, memory of instances, number of instances,
612
+ # and the port used while establishing a connection.
613
+ #
614
+ # @option params [required, String] :release_label
615
+ # The version of FinSpace managed kdb to run.
616
+ #
617
+ # @option params [Types::VpcConfiguration] :vpc_configuration
618
+ # Configuration details about the network where the Privatelink endpoint
619
+ # of the cluster resides.
620
+ #
621
+ # @option params [String] :initialization_script
622
+ # Specifies a Q program that will be run at launch of a cluster. It is a
623
+ # relative path within *.zip* file that contains the custom code, which
624
+ # will be loaded on the cluster. It must include the file name itself.
625
+ # For example, `somedir/init.q`.
626
+ #
627
+ # @option params [Array<Types::KxCommandLineArgument>] :command_line_arguments
628
+ # Defines the key-value pairs to make them available inside the cluster.
629
+ #
630
+ # @option params [Types::CodeConfiguration] :code
631
+ # The details of the custom code that you want to use inside a cluster
632
+ # when analyzing a data. It consists of the S3 source bucket, location,
633
+ # S3 object version, and the relative path from where the custom code is
634
+ # loaded into the cluster.
635
+ #
636
+ # @option params [String] :execution_role
637
+ # An IAM role that defines a set of permissions associated with a
638
+ # cluster. These permissions are assumed when a cluster attempts to
639
+ # access another cluster.
640
+ #
641
+ # @option params [Types::KxSavedownStorageConfiguration] :savedown_storage_configuration
642
+ # The size and type of the temporary storage that is used to hold data
643
+ # during the savedown process. This parameter is required when you
644
+ # choose `clusterType` as RDB. All the data written to this storage
645
+ # space is lost when the cluster node is restarted.
646
+ #
647
+ # @option params [required, String] :az_mode
648
+ # The number of availability zones you want to assign per cluster. This
649
+ # can be one of the following
650
+ #
651
+ # * `SINGLE` – Assigns one availability zone per cluster.
652
+ #
653
+ # * `MULTI` – Assigns all the availability zones per cluster.
654
+ #
655
+ # @option params [String] :availability_zone_id
656
+ # The availability zone identifiers for the requested regions.
657
+ #
658
+ # @option params [Hash<String,String>] :tags
659
+ # A list of key-value pairs to label the cluster. You can add up to 50
660
+ # tags to a cluster.
661
+ #
662
+ # @return [Types::CreateKxClusterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
663
+ #
664
+ # * {Types::CreateKxClusterResponse#environment_id #environment_id} => String
665
+ # * {Types::CreateKxClusterResponse#status #status} => String
666
+ # * {Types::CreateKxClusterResponse#status_reason #status_reason} => String
667
+ # * {Types::CreateKxClusterResponse#cluster_name #cluster_name} => String
668
+ # * {Types::CreateKxClusterResponse#cluster_type #cluster_type} => String
669
+ # * {Types::CreateKxClusterResponse#databases #databases} => Array&lt;Types::KxDatabaseConfiguration&gt;
670
+ # * {Types::CreateKxClusterResponse#cache_storage_configurations #cache_storage_configurations} => Array&lt;Types::KxCacheStorageConfiguration&gt;
671
+ # * {Types::CreateKxClusterResponse#auto_scaling_configuration #auto_scaling_configuration} => Types::AutoScalingConfiguration
672
+ # * {Types::CreateKxClusterResponse#cluster_description #cluster_description} => String
673
+ # * {Types::CreateKxClusterResponse#capacity_configuration #capacity_configuration} => Types::CapacityConfiguration
674
+ # * {Types::CreateKxClusterResponse#release_label #release_label} => String
675
+ # * {Types::CreateKxClusterResponse#vpc_configuration #vpc_configuration} => Types::VpcConfiguration
676
+ # * {Types::CreateKxClusterResponse#initialization_script #initialization_script} => String
677
+ # * {Types::CreateKxClusterResponse#command_line_arguments #command_line_arguments} => Array&lt;Types::KxCommandLineArgument&gt;
678
+ # * {Types::CreateKxClusterResponse#code #code} => Types::CodeConfiguration
679
+ # * {Types::CreateKxClusterResponse#execution_role #execution_role} => String
680
+ # * {Types::CreateKxClusterResponse#last_modified_timestamp #last_modified_timestamp} => Time
681
+ # * {Types::CreateKxClusterResponse#savedown_storage_configuration #savedown_storage_configuration} => Types::KxSavedownStorageConfiguration
682
+ # * {Types::CreateKxClusterResponse#az_mode #az_mode} => String
683
+ # * {Types::CreateKxClusterResponse#availability_zone_id #availability_zone_id} => String
684
+ # * {Types::CreateKxClusterResponse#created_timestamp #created_timestamp} => Time
492
685
  #
493
686
  # @example Request syntax with placeholder values
494
687
  #
495
- # resp = client.get_environment({
496
- # environment_id: "IdType", # required
688
+ # resp = client.create_kx_cluster({
689
+ # client_token: "ClientToken",
690
+ # environment_id: "KxEnvironmentId", # required
691
+ # cluster_name: "KxClusterName", # required
692
+ # cluster_type: "HDB", # required, accepts HDB, RDB, GATEWAY
693
+ # databases: [
694
+ # {
695
+ # database_name: "DatabaseName", # required
696
+ # cache_configurations: [
697
+ # {
698
+ # cache_type: "KxCacheStorageType", # required
699
+ # db_paths: ["DbPath"], # required
700
+ # },
701
+ # ],
702
+ # changeset_id: "ChangesetId",
703
+ # },
704
+ # ],
705
+ # cache_storage_configurations: [
706
+ # {
707
+ # type: "KxCacheStorageType", # required
708
+ # size: 1, # required
709
+ # },
710
+ # ],
711
+ # auto_scaling_configuration: {
712
+ # min_node_count: 1,
713
+ # max_node_count: 1,
714
+ # auto_scaling_metric: "CPU_UTILIZATION_PERCENTAGE", # accepts CPU_UTILIZATION_PERCENTAGE
715
+ # metric_target: 1.0,
716
+ # scale_in_cooldown_seconds: 1.0,
717
+ # scale_out_cooldown_seconds: 1.0,
718
+ # },
719
+ # cluster_description: "KxClusterDescription",
720
+ # capacity_configuration: { # required
721
+ # node_type: "NodeType",
722
+ # node_count: 1,
723
+ # },
724
+ # release_label: "ReleaseLabel", # required
725
+ # vpc_configuration: {
726
+ # vpc_id: "VpcIdString",
727
+ # security_group_ids: ["SecurityGroupIdString"],
728
+ # subnet_ids: ["SubnetIdString"],
729
+ # ip_address_type: "IP_V4", # accepts IP_V4
730
+ # },
731
+ # initialization_script: "InitializationScriptFilePath",
732
+ # command_line_arguments: [
733
+ # {
734
+ # key: "KxCommandLineArgumentKey",
735
+ # value: "KxCommandLineArgumentValue",
736
+ # },
737
+ # ],
738
+ # code: {
739
+ # s3_bucket: "S3Bucket",
740
+ # s3_key: "S3Key",
741
+ # s3_object_version: "S3ObjectVersion",
742
+ # },
743
+ # execution_role: "ExecutionRoleArn",
744
+ # savedown_storage_configuration: {
745
+ # type: "SDS01", # required, accepts SDS01
746
+ # size: 1, # required
747
+ # },
748
+ # az_mode: "SINGLE", # required, accepts SINGLE, MULTI
749
+ # availability_zone_id: "AvailabilityZoneId",
750
+ # tags: {
751
+ # "TagKey" => "TagValue",
752
+ # },
497
753
  # })
498
754
  #
499
755
  # @example Response structure
500
756
  #
501
- # resp.environment.name #=> String
502
- # resp.environment.environment_id #=> String
503
- # resp.environment.aws_account_id #=> String
504
- # resp.environment.status #=> String, one of "CREATE_REQUESTED", "CREATING", "CREATED", "DELETE_REQUESTED", "DELETING", "DELETED", "FAILED_CREATION", "RETRY_DELETION", "FAILED_DELETION", "SUSPENDED"
505
- # resp.environment.environment_url #=> String
506
- # resp.environment.description #=> String
507
- # resp.environment.environment_arn #=> String
508
- # resp.environment.sage_maker_studio_domain_url #=> String
509
- # resp.environment.kms_key_id #=> String
510
- # resp.environment.dedicated_service_account_id #=> String
511
- # resp.environment.federation_mode #=> String, one of "FEDERATED", "LOCAL"
512
- # resp.environment.federation_parameters.saml_metadata_document #=> String
513
- # resp.environment.federation_parameters.saml_metadata_url #=> String
514
- # resp.environment.federation_parameters.application_call_back_url #=> String
515
- # resp.environment.federation_parameters.federation_urn #=> String
516
- # resp.environment.federation_parameters.federation_provider_name #=> String
517
- # resp.environment.federation_parameters.attribute_map #=> Hash
518
- # resp.environment.federation_parameters.attribute_map["FederationAttributeKey"] #=> String
519
- #
520
- # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetEnvironment AWS API Documentation
521
- #
522
- # @overload get_environment(params = {})
757
+ # resp.environment_id #=> String
758
+ # resp.status #=> String, one of "PENDING", "CREATING", "CREATE_FAILED", "RUNNING", "UPDATING", "DELETING", "DELETED", "DELETE_FAILED"
759
+ # resp.status_reason #=> String
760
+ # resp.cluster_name #=> String
761
+ # resp.cluster_type #=> String, one of "HDB", "RDB", "GATEWAY"
762
+ # resp.databases #=> Array
763
+ # resp.databases[0].database_name #=> String
764
+ # resp.databases[0].cache_configurations #=> Array
765
+ # resp.databases[0].cache_configurations[0].cache_type #=> String
766
+ # resp.databases[0].cache_configurations[0].db_paths #=> Array
767
+ # resp.databases[0].cache_configurations[0].db_paths[0] #=> String
768
+ # resp.databases[0].changeset_id #=> String
769
+ # resp.cache_storage_configurations #=> Array
770
+ # resp.cache_storage_configurations[0].type #=> String
771
+ # resp.cache_storage_configurations[0].size #=> Integer
772
+ # resp.auto_scaling_configuration.min_node_count #=> Integer
773
+ # resp.auto_scaling_configuration.max_node_count #=> Integer
774
+ # resp.auto_scaling_configuration.auto_scaling_metric #=> String, one of "CPU_UTILIZATION_PERCENTAGE"
775
+ # resp.auto_scaling_configuration.metric_target #=> Float
776
+ # resp.auto_scaling_configuration.scale_in_cooldown_seconds #=> Float
777
+ # resp.auto_scaling_configuration.scale_out_cooldown_seconds #=> Float
778
+ # resp.cluster_description #=> String
779
+ # resp.capacity_configuration.node_type #=> String
780
+ # resp.capacity_configuration.node_count #=> Integer
781
+ # resp.release_label #=> String
782
+ # resp.vpc_configuration.vpc_id #=> String
783
+ # resp.vpc_configuration.security_group_ids #=> Array
784
+ # resp.vpc_configuration.security_group_ids[0] #=> String
785
+ # resp.vpc_configuration.subnet_ids #=> Array
786
+ # resp.vpc_configuration.subnet_ids[0] #=> String
787
+ # resp.vpc_configuration.ip_address_type #=> String, one of "IP_V4"
788
+ # resp.initialization_script #=> String
789
+ # resp.command_line_arguments #=> Array
790
+ # resp.command_line_arguments[0].key #=> String
791
+ # resp.command_line_arguments[0].value #=> String
792
+ # resp.code.s3_bucket #=> String
793
+ # resp.code.s3_key #=> String
794
+ # resp.code.s3_object_version #=> String
795
+ # resp.execution_role #=> String
796
+ # resp.last_modified_timestamp #=> Time
797
+ # resp.savedown_storage_configuration.type #=> String, one of "SDS01"
798
+ # resp.savedown_storage_configuration.size #=> Integer
799
+ # resp.az_mode #=> String, one of "SINGLE", "MULTI"
800
+ # resp.availability_zone_id #=> String
801
+ # resp.created_timestamp #=> Time
802
+ #
803
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxCluster AWS API Documentation
804
+ #
805
+ # @overload create_kx_cluster(params = {})
523
806
  # @param [Hash] params ({})
524
- def get_environment(params = {}, options = {})
525
- req = build_request(:get_environment, params)
807
+ def create_kx_cluster(params = {}, options = {})
808
+ req = build_request(:create_kx_cluster, params)
526
809
  req.send_request(options)
527
810
  end
528
811
 
529
- # A list of all of your FinSpace environments.
812
+ # Creates a new kdb database in the environment.
530
813
  #
531
- # @option params [String] :next_token
532
- # A token generated by FinSpace that specifies where to continue
533
- # pagination if a previous request was truncated. To get the next set of
534
- # pages, pass in the nextToken value from the response object of the
535
- # previous page call.
814
+ # @option params [required, String] :environment_id
815
+ # A unique identifier for the kdb environment.
536
816
  #
537
- # @option params [Integer] :max_results
538
- # The maximum number of results to return in this request.
817
+ # @option params [required, String] :database_name
818
+ # The name of the kdb database.
539
819
  #
540
- # @return [Types::ListEnvironmentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
820
+ # @option params [String] :description
821
+ # A description of the database.
541
822
  #
542
- # * {Types::ListEnvironmentsResponse#environments #environments} => Array&lt;Types::Environment&gt;
543
- # * {Types::ListEnvironmentsResponse#next_token #next_token} => String
823
+ # @option params [Hash<String,String>] :tags
824
+ # A list of key-value pairs to label the kdb database. You can add up to
825
+ # 50 tags to your kdb database
826
+ #
827
+ # @option params [required, String] :client_token
828
+ # A token that ensures idempotency. This token expires in 10 minutes.
829
+ #
830
+ # **A suitable default value is auto-generated.** You should normally
831
+ # not need to pass this option.**
832
+ #
833
+ # @return [Types::CreateKxDatabaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
834
+ #
835
+ # * {Types::CreateKxDatabaseResponse#database_name #database_name} => String
836
+ # * {Types::CreateKxDatabaseResponse#database_arn #database_arn} => String
837
+ # * {Types::CreateKxDatabaseResponse#environment_id #environment_id} => String
838
+ # * {Types::CreateKxDatabaseResponse#description #description} => String
839
+ # * {Types::CreateKxDatabaseResponse#created_timestamp #created_timestamp} => Time
840
+ # * {Types::CreateKxDatabaseResponse#last_modified_timestamp #last_modified_timestamp} => Time
544
841
  #
545
842
  # @example Request syntax with placeholder values
546
843
  #
547
- # resp = client.list_environments({
548
- # next_token: "PaginationToken",
549
- # max_results: 1,
844
+ # resp = client.create_kx_database({
845
+ # environment_id: "EnvironmentId", # required
846
+ # database_name: "DatabaseName", # required
847
+ # description: "Description",
848
+ # tags: {
849
+ # "TagKey" => "TagValue",
850
+ # },
851
+ # client_token: "ClientTokenString", # required
550
852
  # })
551
853
  #
552
854
  # @example Response structure
553
855
  #
554
- # resp.environments #=> Array
555
- # resp.environments[0].name #=> String
556
- # resp.environments[0].environment_id #=> String
557
- # resp.environments[0].aws_account_id #=> String
558
- # resp.environments[0].status #=> String, one of "CREATE_REQUESTED", "CREATING", "CREATED", "DELETE_REQUESTED", "DELETING", "DELETED", "FAILED_CREATION", "RETRY_DELETION", "FAILED_DELETION", "SUSPENDED"
559
- # resp.environments[0].environment_url #=> String
560
- # resp.environments[0].description #=> String
561
- # resp.environments[0].environment_arn #=> String
562
- # resp.environments[0].sage_maker_studio_domain_url #=> String
563
- # resp.environments[0].kms_key_id #=> String
564
- # resp.environments[0].dedicated_service_account_id #=> String
565
- # resp.environments[0].federation_mode #=> String, one of "FEDERATED", "LOCAL"
566
- # resp.environments[0].federation_parameters.saml_metadata_document #=> String
567
- # resp.environments[0].federation_parameters.saml_metadata_url #=> String
568
- # resp.environments[0].federation_parameters.application_call_back_url #=> String
569
- # resp.environments[0].federation_parameters.federation_urn #=> String
570
- # resp.environments[0].federation_parameters.federation_provider_name #=> String
571
- # resp.environments[0].federation_parameters.attribute_map #=> Hash
572
- # resp.environments[0].federation_parameters.attribute_map["FederationAttributeKey"] #=> String
573
- # resp.next_token #=> String
856
+ # resp.database_name #=> String
857
+ # resp.database_arn #=> String
858
+ # resp.environment_id #=> String
859
+ # resp.description #=> String
860
+ # resp.created_timestamp #=> Time
861
+ # resp.last_modified_timestamp #=> Time
574
862
  #
575
- # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListEnvironments AWS API Documentation
863
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxDatabase AWS API Documentation
576
864
  #
577
- # @overload list_environments(params = {})
865
+ # @overload create_kx_database(params = {})
578
866
  # @param [Hash] params ({})
579
- def list_environments(params = {}, options = {})
580
- req = build_request(:list_environments, params)
867
+ def create_kx_database(params = {}, options = {})
868
+ req = build_request(:create_kx_database, params)
581
869
  req.send_request(options)
582
870
  end
583
871
 
584
- # A list of all tags for a resource.
872
+ # Creates a managed kdb environment for the account.
585
873
  #
586
- # @option params [required, String] :resource_arn
587
- # The Amazon Resource Name of the resource.
874
+ # @option params [required, String] :name
875
+ # The name of the kdb environment that you want to create.
588
876
  #
589
- # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
877
+ # @option params [String] :description
878
+ # A description for the kdb environment.
590
879
  #
591
- # * {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt;
880
+ # @option params [required, String] :kms_key_id
881
+ # The KMS key ID to encrypt your data in the FinSpace environment.
882
+ #
883
+ # @option params [Hash<String,String>] :tags
884
+ # A list of key-value pairs to label the kdb environment. You can add up
885
+ # to 50 tags to your kdb environment.
886
+ #
887
+ # @option params [String] :client_token
888
+ # A token that ensures idempotency. This token expires in 10 minutes.
889
+ #
890
+ # @return [Types::CreateKxEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
891
+ #
892
+ # * {Types::CreateKxEnvironmentResponse#name #name} => String
893
+ # * {Types::CreateKxEnvironmentResponse#status #status} => String
894
+ # * {Types::CreateKxEnvironmentResponse#environment_id #environment_id} => String
895
+ # * {Types::CreateKxEnvironmentResponse#description #description} => String
896
+ # * {Types::CreateKxEnvironmentResponse#environment_arn #environment_arn} => String
897
+ # * {Types::CreateKxEnvironmentResponse#kms_key_id #kms_key_id} => String
898
+ # * {Types::CreateKxEnvironmentResponse#creation_timestamp #creation_timestamp} => Time
592
899
  #
593
900
  # @example Request syntax with placeholder values
594
901
  #
595
- # resp = client.list_tags_for_resource({
596
- # resource_arn: "EnvironmentArn", # required
902
+ # resp = client.create_kx_environment({
903
+ # name: "KxEnvironmentName", # required
904
+ # description: "Description",
905
+ # kms_key_id: "KmsKeyARN", # required
906
+ # tags: {
907
+ # "TagKey" => "TagValue",
908
+ # },
909
+ # client_token: "ClientToken",
597
910
  # })
598
911
  #
599
912
  # @example Response structure
600
913
  #
601
- # resp.tags #=> Hash
602
- # resp.tags["TagKey"] #=> String
914
+ # resp.name #=> String
915
+ # resp.status #=> String, one of "CREATE_REQUESTED", "CREATING", "CREATED", "DELETE_REQUESTED", "DELETING", "DELETED", "FAILED_CREATION", "RETRY_DELETION", "FAILED_DELETION", "UPDATE_NETWORK_REQUESTED", "UPDATING_NETWORK", "FAILED_UPDATING_NETWORK", "SUSPENDED"
916
+ # resp.environment_id #=> String
917
+ # resp.description #=> String
918
+ # resp.environment_arn #=> String
919
+ # resp.kms_key_id #=> String
920
+ # resp.creation_timestamp #=> Time
603
921
  #
604
- # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListTagsForResource AWS API Documentation
922
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxEnvironment AWS API Documentation
605
923
  #
606
- # @overload list_tags_for_resource(params = {})
924
+ # @overload create_kx_environment(params = {})
607
925
  # @param [Hash] params ({})
608
- def list_tags_for_resource(params = {}, options = {})
609
- req = build_request(:list_tags_for_resource, params)
926
+ def create_kx_environment(params = {}, options = {})
927
+ req = build_request(:create_kx_environment, params)
610
928
  req.send_request(options)
611
929
  end
612
930
 
613
- # Adds metadata tags to a FinSpace resource.
931
+ # Creates a user in FinSpace kdb environment with an associated IAM
932
+ # role.
614
933
  #
615
- # @option params [required, String] :resource_arn
616
- # The Amazon Resource Name (ARN) for the resource.
934
+ # @option params [required, String] :environment_id
935
+ # A unique identifier for the kdb environment where you want to create a
936
+ # user.
617
937
  #
618
- # @option params [required, Hash<String,String>] :tags
619
- # One or more tags to be assigned to the resource.
938
+ # @option params [required, String] :user_name
939
+ # A unique identifier for the user.
620
940
  #
621
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
941
+ # @option params [required, String] :iam_role
942
+ # The IAM role ARN that will be associated with the user.
943
+ #
944
+ # @option params [Hash<String,String>] :tags
945
+ # A list of key-value pairs to label the user. You can add up to 50 tags
946
+ # to a user.
947
+ #
948
+ # @option params [String] :client_token
949
+ # A token that ensures idempotency. This token expires in 10 minutes.
950
+ #
951
+ # @return [Types::CreateKxUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
952
+ #
953
+ # * {Types::CreateKxUserResponse#user_name #user_name} => String
954
+ # * {Types::CreateKxUserResponse#user_arn #user_arn} => String
955
+ # * {Types::CreateKxUserResponse#environment_id #environment_id} => String
956
+ # * {Types::CreateKxUserResponse#iam_role #iam_role} => String
622
957
  #
623
958
  # @example Request syntax with placeholder values
624
959
  #
625
- # resp = client.tag_resource({
626
- # resource_arn: "EnvironmentArn", # required
627
- # tags: { # required
960
+ # resp = client.create_kx_user({
961
+ # environment_id: "IdType", # required
962
+ # user_name: "KxUserNameString", # required
963
+ # iam_role: "RoleArn", # required
964
+ # tags: {
628
965
  # "TagKey" => "TagValue",
629
966
  # },
967
+ # client_token: "ClientToken",
630
968
  # })
631
969
  #
632
- # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/TagResource AWS API Documentation
970
+ # @example Response structure
633
971
  #
634
- # @overload tag_resource(params = {})
972
+ # resp.user_name #=> String
973
+ # resp.user_arn #=> String
974
+ # resp.environment_id #=> String
975
+ # resp.iam_role #=> String
976
+ #
977
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxUser AWS API Documentation
978
+ #
979
+ # @overload create_kx_user(params = {})
635
980
  # @param [Hash] params ({})
636
- def tag_resource(params = {}, options = {})
637
- req = build_request(:tag_resource, params)
981
+ def create_kx_user(params = {}, options = {})
982
+ req = build_request(:create_kx_user, params)
638
983
  req.send_request(options)
639
984
  end
640
985
 
641
- # Removes metadata tags from a FinSpace resource.
642
- #
643
- # @option params [required, String] :resource_arn
644
- # A FinSpace resource from which you want to remove a tag or tags. The
645
- # value for this parameter is an Amazon Resource Name (ARN).
986
+ # Delete an FinSpace environment.
646
987
  #
647
- # @option params [required, Array<String>] :tag_keys
648
- # The tag keys (names) of one or more tags to be removed.
988
+ # @option params [required, String] :environment_id
989
+ # The identifier for the FinSpace environment.
649
990
  #
650
991
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
651
992
  #
652
993
  # @example Request syntax with placeholder values
653
994
  #
654
- # resp = client.untag_resource({
655
- # resource_arn: "EnvironmentArn", # required
656
- # tag_keys: ["TagKey"], # required
995
+ # resp = client.delete_environment({
996
+ # environment_id: "IdType", # required
657
997
  # })
658
998
  #
659
- # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UntagResource AWS API Documentation
999
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteEnvironment AWS API Documentation
660
1000
  #
661
- # @overload untag_resource(params = {})
1001
+ # @overload delete_environment(params = {})
662
1002
  # @param [Hash] params ({})
663
- def untag_resource(params = {}, options = {})
664
- req = build_request(:untag_resource, params)
1003
+ def delete_environment(params = {}, options = {})
1004
+ req = build_request(:delete_environment, params)
665
1005
  req.send_request(options)
666
1006
  end
667
1007
 
668
- # Update your FinSpace environment.
1008
+ # Deletes a kdb cluster.
669
1009
  #
670
1010
  # @option params [required, String] :environment_id
671
- # The identifier of the FinSpace environment.
1011
+ # A unique identifier for the kdb environment.
672
1012
  #
673
- # @option params [String] :name
674
- # The name of the environment.
1013
+ # @option params [required, String] :cluster_name
1014
+ # The name of the cluster that you want to delete.
675
1015
  #
676
- # @option params [String] :description
677
- # The description of the environment.
1016
+ # @option params [String] :client_token
1017
+ # A token that ensures idempotency. This token expires in 10 minutes.
678
1018
  #
679
- # @option params [String] :federation_mode
680
- # Authentication mode for the environment.
1019
+ # **A suitable default value is auto-generated.** You should normally
1020
+ # not need to pass this option.**
681
1021
  #
682
- # * `FEDERATED` - Users access FinSpace through Single Sign On (SSO) via
683
- # your Identity provider.
1022
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
684
1023
  #
685
- # * `LOCAL` - Users access FinSpace via email and password managed
686
- # within the FinSpace environment.
1024
+ # @example Request syntax with placeholder values
687
1025
  #
688
- # @option params [Types::FederationParameters] :federation_parameters
689
- # Configuration information when authentication mode is FEDERATED.
1026
+ # resp = client.delete_kx_cluster({
1027
+ # environment_id: "KxEnvironmentId", # required
1028
+ # cluster_name: "KxClusterName", # required
1029
+ # client_token: "ClientTokenString",
1030
+ # })
690
1031
  #
691
- # @return [Types::UpdateEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1032
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxCluster AWS API Documentation
692
1033
  #
693
- # * {Types::UpdateEnvironmentResponse#environment #environment} => Types::Environment
1034
+ # @overload delete_kx_cluster(params = {})
1035
+ # @param [Hash] params ({})
1036
+ def delete_kx_cluster(params = {}, options = {})
1037
+ req = build_request(:delete_kx_cluster, params)
1038
+ req.send_request(options)
1039
+ end
1040
+
1041
+ # Deletes the specified database and all of its associated data. This
1042
+ # action is irreversible. You must copy any data out of the database
1043
+ # before deleting it if the data is to be retained.
1044
+ #
1045
+ # @option params [required, String] :environment_id
1046
+ # A unique identifier for the kdb environment.
1047
+ #
1048
+ # @option params [required, String] :database_name
1049
+ # The name of the kdb database that you want to delete.
1050
+ #
1051
+ # @option params [required, String] :client_token
1052
+ # A token that ensures idempotency. This token expires in 10 minutes.
1053
+ #
1054
+ # **A suitable default value is auto-generated.** You should normally
1055
+ # not need to pass this option.**
1056
+ #
1057
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
694
1058
  #
695
1059
  # @example Request syntax with placeholder values
696
1060
  #
697
- # resp = client.update_environment({
698
- # environment_id: "IdType", # required
699
- # name: "EnvironmentName",
700
- # description: "Description",
701
- # federation_mode: "FEDERATED", # accepts FEDERATED, LOCAL
702
- # federation_parameters: {
703
- # saml_metadata_document: "SamlMetadataDocument",
704
- # saml_metadata_url: "url",
705
- # application_call_back_url: "url",
706
- # federation_urn: "urn",
707
- # federation_provider_name: "FederationProviderName",
708
- # attribute_map: {
709
- # "FederationAttributeKey" => "url",
710
- # },
711
- # },
1061
+ # resp = client.delete_kx_database({
1062
+ # environment_id: "EnvironmentId", # required
1063
+ # database_name: "DatabaseName", # required
1064
+ # client_token: "ClientTokenString", # required
712
1065
  # })
713
1066
  #
714
- # @example Response structure
1067
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxDatabase AWS API Documentation
715
1068
  #
716
- # resp.environment.name #=> String
717
- # resp.environment.environment_id #=> String
718
- # resp.environment.aws_account_id #=> String
719
- # resp.environment.status #=> String, one of "CREATE_REQUESTED", "CREATING", "CREATED", "DELETE_REQUESTED", "DELETING", "DELETED", "FAILED_CREATION", "RETRY_DELETION", "FAILED_DELETION", "SUSPENDED"
720
- # resp.environment.environment_url #=> String
721
- # resp.environment.description #=> String
1069
+ # @overload delete_kx_database(params = {})
1070
+ # @param [Hash] params ({})
1071
+ def delete_kx_database(params = {}, options = {})
1072
+ req = build_request(:delete_kx_database, params)
1073
+ req.send_request(options)
1074
+ end
1075
+
1076
+ # Deletes the kdb environment. This action is irreversible. Deleting a
1077
+ # kdb environment will remove all the associated data and any services
1078
+ # running in it.
1079
+ #
1080
+ # @option params [required, String] :environment_id
1081
+ # A unique identifier for the kdb environment.
1082
+ #
1083
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1084
+ #
1085
+ # @example Request syntax with placeholder values
1086
+ #
1087
+ # resp = client.delete_kx_environment({
1088
+ # environment_id: "IdType", # required
1089
+ # })
1090
+ #
1091
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxEnvironment AWS API Documentation
1092
+ #
1093
+ # @overload delete_kx_environment(params = {})
1094
+ # @param [Hash] params ({})
1095
+ def delete_kx_environment(params = {}, options = {})
1096
+ req = build_request(:delete_kx_environment, params)
1097
+ req.send_request(options)
1098
+ end
1099
+
1100
+ # Deletes a user in the specified kdb environment.
1101
+ #
1102
+ # @option params [required, String] :user_name
1103
+ # A unique identifier for the user that you want to delete.
1104
+ #
1105
+ # @option params [required, String] :environment_id
1106
+ # A unique identifier for the kdb environment.
1107
+ #
1108
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1109
+ #
1110
+ # @example Request syntax with placeholder values
1111
+ #
1112
+ # resp = client.delete_kx_user({
1113
+ # user_name: "KxUserNameString", # required
1114
+ # environment_id: "IdType", # required
1115
+ # })
1116
+ #
1117
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxUser AWS API Documentation
1118
+ #
1119
+ # @overload delete_kx_user(params = {})
1120
+ # @param [Hash] params ({})
1121
+ def delete_kx_user(params = {}, options = {})
1122
+ req = build_request(:delete_kx_user, params)
1123
+ req.send_request(options)
1124
+ end
1125
+
1126
+ # Returns the FinSpace environment object.
1127
+ #
1128
+ # @option params [required, String] :environment_id
1129
+ # The identifier of the FinSpace environment.
1130
+ #
1131
+ # @return [Types::GetEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1132
+ #
1133
+ # * {Types::GetEnvironmentResponse#environment #environment} => Types::Environment
1134
+ #
1135
+ # @example Request syntax with placeholder values
1136
+ #
1137
+ # resp = client.get_environment({
1138
+ # environment_id: "IdType", # required
1139
+ # })
1140
+ #
1141
+ # @example Response structure
1142
+ #
1143
+ # resp.environment.name #=> String
1144
+ # resp.environment.environment_id #=> String
1145
+ # resp.environment.aws_account_id #=> String
1146
+ # resp.environment.status #=> String, one of "CREATE_REQUESTED", "CREATING", "CREATED", "DELETE_REQUESTED", "DELETING", "DELETED", "FAILED_CREATION", "RETRY_DELETION", "FAILED_DELETION", "UPDATE_NETWORK_REQUESTED", "UPDATING_NETWORK", "FAILED_UPDATING_NETWORK", "SUSPENDED"
1147
+ # resp.environment.environment_url #=> String
1148
+ # resp.environment.description #=> String
1149
+ # resp.environment.environment_arn #=> String
1150
+ # resp.environment.sage_maker_studio_domain_url #=> String
1151
+ # resp.environment.kms_key_id #=> String
1152
+ # resp.environment.dedicated_service_account_id #=> String
1153
+ # resp.environment.federation_mode #=> String, one of "FEDERATED", "LOCAL"
1154
+ # resp.environment.federation_parameters.saml_metadata_document #=> String
1155
+ # resp.environment.federation_parameters.saml_metadata_url #=> String
1156
+ # resp.environment.federation_parameters.application_call_back_url #=> String
1157
+ # resp.environment.federation_parameters.federation_urn #=> String
1158
+ # resp.environment.federation_parameters.federation_provider_name #=> String
1159
+ # resp.environment.federation_parameters.attribute_map #=> Hash
1160
+ # resp.environment.federation_parameters.attribute_map["FederationAttributeKey"] #=> String
1161
+ #
1162
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetEnvironment AWS API Documentation
1163
+ #
1164
+ # @overload get_environment(params = {})
1165
+ # @param [Hash] params ({})
1166
+ def get_environment(params = {}, options = {})
1167
+ req = build_request(:get_environment, params)
1168
+ req.send_request(options)
1169
+ end
1170
+
1171
+ # Returns information about a kdb changeset.
1172
+ #
1173
+ # @option params [required, String] :environment_id
1174
+ # A unique identifier for the kdb environment.
1175
+ #
1176
+ # @option params [required, String] :database_name
1177
+ # The name of the kdb database.
1178
+ #
1179
+ # @option params [required, String] :changeset_id
1180
+ # A unique identifier of the changeset for which you want to retrieve
1181
+ # data.
1182
+ #
1183
+ # @return [Types::GetKxChangesetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1184
+ #
1185
+ # * {Types::GetKxChangesetResponse#changeset_id #changeset_id} => String
1186
+ # * {Types::GetKxChangesetResponse#database_name #database_name} => String
1187
+ # * {Types::GetKxChangesetResponse#environment_id #environment_id} => String
1188
+ # * {Types::GetKxChangesetResponse#change_requests #change_requests} => Array&lt;Types::ChangeRequest&gt;
1189
+ # * {Types::GetKxChangesetResponse#created_timestamp #created_timestamp} => Time
1190
+ # * {Types::GetKxChangesetResponse#active_from_timestamp #active_from_timestamp} => Time
1191
+ # * {Types::GetKxChangesetResponse#last_modified_timestamp #last_modified_timestamp} => Time
1192
+ # * {Types::GetKxChangesetResponse#status #status} => String
1193
+ # * {Types::GetKxChangesetResponse#error_info #error_info} => Types::ErrorInfo
1194
+ #
1195
+ # @example Request syntax with placeholder values
1196
+ #
1197
+ # resp = client.get_kx_changeset({
1198
+ # environment_id: "EnvironmentId", # required
1199
+ # database_name: "DatabaseName", # required
1200
+ # changeset_id: "ChangesetId", # required
1201
+ # })
1202
+ #
1203
+ # @example Response structure
1204
+ #
1205
+ # resp.changeset_id #=> String
1206
+ # resp.database_name #=> String
1207
+ # resp.environment_id #=> String
1208
+ # resp.change_requests #=> Array
1209
+ # resp.change_requests[0].change_type #=> String, one of "PUT", "DELETE"
1210
+ # resp.change_requests[0].s3_path #=> String
1211
+ # resp.change_requests[0].db_path #=> String
1212
+ # resp.created_timestamp #=> Time
1213
+ # resp.active_from_timestamp #=> Time
1214
+ # resp.last_modified_timestamp #=> Time
1215
+ # resp.status #=> String, one of "PENDING", "PROCESSING", "FAILED", "COMPLETED"
1216
+ # resp.error_info.error_message #=> String
1217
+ # resp.error_info.error_type #=> String, one of "The inputs to this request are invalid.", "Service limits have been exceeded.", "Missing required permission to perform this request.", "One or more inputs to this request were not found.", "The system temporarily lacks sufficient resources to process the request.", "An internal error has occurred.", "Cancelled", "A user recoverable error has occurred"
1218
+ #
1219
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxChangeset AWS API Documentation
1220
+ #
1221
+ # @overload get_kx_changeset(params = {})
1222
+ # @param [Hash] params ({})
1223
+ def get_kx_changeset(params = {}, options = {})
1224
+ req = build_request(:get_kx_changeset, params)
1225
+ req.send_request(options)
1226
+ end
1227
+
1228
+ # Retrieves information about a kdb cluster.
1229
+ #
1230
+ # @option params [required, String] :environment_id
1231
+ # A unique identifier for the kdb environment.
1232
+ #
1233
+ # @option params [required, String] :cluster_name
1234
+ # The name of the cluster that you want to retrieve.
1235
+ #
1236
+ # @return [Types::GetKxClusterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1237
+ #
1238
+ # * {Types::GetKxClusterResponse#status #status} => String
1239
+ # * {Types::GetKxClusterResponse#status_reason #status_reason} => String
1240
+ # * {Types::GetKxClusterResponse#cluster_name #cluster_name} => String
1241
+ # * {Types::GetKxClusterResponse#cluster_type #cluster_type} => String
1242
+ # * {Types::GetKxClusterResponse#databases #databases} => Array&lt;Types::KxDatabaseConfiguration&gt;
1243
+ # * {Types::GetKxClusterResponse#cache_storage_configurations #cache_storage_configurations} => Array&lt;Types::KxCacheStorageConfiguration&gt;
1244
+ # * {Types::GetKxClusterResponse#auto_scaling_configuration #auto_scaling_configuration} => Types::AutoScalingConfiguration
1245
+ # * {Types::GetKxClusterResponse#cluster_description #cluster_description} => String
1246
+ # * {Types::GetKxClusterResponse#capacity_configuration #capacity_configuration} => Types::CapacityConfiguration
1247
+ # * {Types::GetKxClusterResponse#release_label #release_label} => String
1248
+ # * {Types::GetKxClusterResponse#vpc_configuration #vpc_configuration} => Types::VpcConfiguration
1249
+ # * {Types::GetKxClusterResponse#initialization_script #initialization_script} => String
1250
+ # * {Types::GetKxClusterResponse#command_line_arguments #command_line_arguments} => Array&lt;Types::KxCommandLineArgument&gt;
1251
+ # * {Types::GetKxClusterResponse#code #code} => Types::CodeConfiguration
1252
+ # * {Types::GetKxClusterResponse#execution_role #execution_role} => String
1253
+ # * {Types::GetKxClusterResponse#last_modified_timestamp #last_modified_timestamp} => Time
1254
+ # * {Types::GetKxClusterResponse#savedown_storage_configuration #savedown_storage_configuration} => Types::KxSavedownStorageConfiguration
1255
+ # * {Types::GetKxClusterResponse#az_mode #az_mode} => String
1256
+ # * {Types::GetKxClusterResponse#availability_zone_id #availability_zone_id} => String
1257
+ # * {Types::GetKxClusterResponse#created_timestamp #created_timestamp} => Time
1258
+ #
1259
+ # @example Request syntax with placeholder values
1260
+ #
1261
+ # resp = client.get_kx_cluster({
1262
+ # environment_id: "KxEnvironmentId", # required
1263
+ # cluster_name: "KxClusterName", # required
1264
+ # })
1265
+ #
1266
+ # @example Response structure
1267
+ #
1268
+ # resp.status #=> String, one of "PENDING", "CREATING", "CREATE_FAILED", "RUNNING", "UPDATING", "DELETING", "DELETED", "DELETE_FAILED"
1269
+ # resp.status_reason #=> String
1270
+ # resp.cluster_name #=> String
1271
+ # resp.cluster_type #=> String, one of "HDB", "RDB", "GATEWAY"
1272
+ # resp.databases #=> Array
1273
+ # resp.databases[0].database_name #=> String
1274
+ # resp.databases[0].cache_configurations #=> Array
1275
+ # resp.databases[0].cache_configurations[0].cache_type #=> String
1276
+ # resp.databases[0].cache_configurations[0].db_paths #=> Array
1277
+ # resp.databases[0].cache_configurations[0].db_paths[0] #=> String
1278
+ # resp.databases[0].changeset_id #=> String
1279
+ # resp.cache_storage_configurations #=> Array
1280
+ # resp.cache_storage_configurations[0].type #=> String
1281
+ # resp.cache_storage_configurations[0].size #=> Integer
1282
+ # resp.auto_scaling_configuration.min_node_count #=> Integer
1283
+ # resp.auto_scaling_configuration.max_node_count #=> Integer
1284
+ # resp.auto_scaling_configuration.auto_scaling_metric #=> String, one of "CPU_UTILIZATION_PERCENTAGE"
1285
+ # resp.auto_scaling_configuration.metric_target #=> Float
1286
+ # resp.auto_scaling_configuration.scale_in_cooldown_seconds #=> Float
1287
+ # resp.auto_scaling_configuration.scale_out_cooldown_seconds #=> Float
1288
+ # resp.cluster_description #=> String
1289
+ # resp.capacity_configuration.node_type #=> String
1290
+ # resp.capacity_configuration.node_count #=> Integer
1291
+ # resp.release_label #=> String
1292
+ # resp.vpc_configuration.vpc_id #=> String
1293
+ # resp.vpc_configuration.security_group_ids #=> Array
1294
+ # resp.vpc_configuration.security_group_ids[0] #=> String
1295
+ # resp.vpc_configuration.subnet_ids #=> Array
1296
+ # resp.vpc_configuration.subnet_ids[0] #=> String
1297
+ # resp.vpc_configuration.ip_address_type #=> String, one of "IP_V4"
1298
+ # resp.initialization_script #=> String
1299
+ # resp.command_line_arguments #=> Array
1300
+ # resp.command_line_arguments[0].key #=> String
1301
+ # resp.command_line_arguments[0].value #=> String
1302
+ # resp.code.s3_bucket #=> String
1303
+ # resp.code.s3_key #=> String
1304
+ # resp.code.s3_object_version #=> String
1305
+ # resp.execution_role #=> String
1306
+ # resp.last_modified_timestamp #=> Time
1307
+ # resp.savedown_storage_configuration.type #=> String, one of "SDS01"
1308
+ # resp.savedown_storage_configuration.size #=> Integer
1309
+ # resp.az_mode #=> String, one of "SINGLE", "MULTI"
1310
+ # resp.availability_zone_id #=> String
1311
+ # resp.created_timestamp #=> Time
1312
+ #
1313
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxCluster AWS API Documentation
1314
+ #
1315
+ # @overload get_kx_cluster(params = {})
1316
+ # @param [Hash] params ({})
1317
+ def get_kx_cluster(params = {}, options = {})
1318
+ req = build_request(:get_kx_cluster, params)
1319
+ req.send_request(options)
1320
+ end
1321
+
1322
+ # Retrieves a connection string for a user to connect to a kdb cluster.
1323
+ # You must call this API using the same role that you have defined while
1324
+ # creating a user.
1325
+ #
1326
+ # @option params [required, String] :user_arn
1327
+ # The Amazon Resource Name (ARN) that identifies the user. For more
1328
+ # information about ARNs and how to use ARNs in policies, see [IAM
1329
+ # Identifiers](IAM/latest/UserGuide/reference_identifiers.html) in the
1330
+ # *IAM User Guide*.
1331
+ #
1332
+ # @option params [required, String] :environment_id
1333
+ # A unique identifier for the kdb environment.
1334
+ #
1335
+ # @option params [required, String] :cluster_name
1336
+ # A name of the kdb cluster.
1337
+ #
1338
+ # @return [Types::GetKxConnectionStringResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1339
+ #
1340
+ # * {Types::GetKxConnectionStringResponse#signed_connection_string #signed_connection_string} => String
1341
+ #
1342
+ # @example Request syntax with placeholder values
1343
+ #
1344
+ # resp = client.get_kx_connection_string({
1345
+ # user_arn: "KxUserArn", # required
1346
+ # environment_id: "IdType", # required
1347
+ # cluster_name: "KxClusterName", # required
1348
+ # })
1349
+ #
1350
+ # @example Response structure
1351
+ #
1352
+ # resp.signed_connection_string #=> String
1353
+ #
1354
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxConnectionString AWS API Documentation
1355
+ #
1356
+ # @overload get_kx_connection_string(params = {})
1357
+ # @param [Hash] params ({})
1358
+ def get_kx_connection_string(params = {}, options = {})
1359
+ req = build_request(:get_kx_connection_string, params)
1360
+ req.send_request(options)
1361
+ end
1362
+
1363
+ # Returns database information for the specified environment ID.
1364
+ #
1365
+ # @option params [required, String] :environment_id
1366
+ # A unique identifier for the kdb environment.
1367
+ #
1368
+ # @option params [required, String] :database_name
1369
+ # The name of the kdb database.
1370
+ #
1371
+ # @return [Types::GetKxDatabaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1372
+ #
1373
+ # * {Types::GetKxDatabaseResponse#database_name #database_name} => String
1374
+ # * {Types::GetKxDatabaseResponse#database_arn #database_arn} => String
1375
+ # * {Types::GetKxDatabaseResponse#environment_id #environment_id} => String
1376
+ # * {Types::GetKxDatabaseResponse#description #description} => String
1377
+ # * {Types::GetKxDatabaseResponse#created_timestamp #created_timestamp} => Time
1378
+ # * {Types::GetKxDatabaseResponse#last_modified_timestamp #last_modified_timestamp} => Time
1379
+ # * {Types::GetKxDatabaseResponse#last_completed_changeset_id #last_completed_changeset_id} => String
1380
+ # * {Types::GetKxDatabaseResponse#num_bytes #num_bytes} => Integer
1381
+ # * {Types::GetKxDatabaseResponse#num_changesets #num_changesets} => Integer
1382
+ # * {Types::GetKxDatabaseResponse#num_files #num_files} => Integer
1383
+ #
1384
+ # @example Request syntax with placeholder values
1385
+ #
1386
+ # resp = client.get_kx_database({
1387
+ # environment_id: "EnvironmentId", # required
1388
+ # database_name: "DatabaseName", # required
1389
+ # })
1390
+ #
1391
+ # @example Response structure
1392
+ #
1393
+ # resp.database_name #=> String
1394
+ # resp.database_arn #=> String
1395
+ # resp.environment_id #=> String
1396
+ # resp.description #=> String
1397
+ # resp.created_timestamp #=> Time
1398
+ # resp.last_modified_timestamp #=> Time
1399
+ # resp.last_completed_changeset_id #=> String
1400
+ # resp.num_bytes #=> Integer
1401
+ # resp.num_changesets #=> Integer
1402
+ # resp.num_files #=> Integer
1403
+ #
1404
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxDatabase AWS API Documentation
1405
+ #
1406
+ # @overload get_kx_database(params = {})
1407
+ # @param [Hash] params ({})
1408
+ def get_kx_database(params = {}, options = {})
1409
+ req = build_request(:get_kx_database, params)
1410
+ req.send_request(options)
1411
+ end
1412
+
1413
+ # Retrieves all the information for the specified kdb environment.
1414
+ #
1415
+ # @option params [required, String] :environment_id
1416
+ # A unique identifier for the kdb environment.
1417
+ #
1418
+ # @return [Types::GetKxEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1419
+ #
1420
+ # * {Types::GetKxEnvironmentResponse#name #name} => String
1421
+ # * {Types::GetKxEnvironmentResponse#environment_id #environment_id} => String
1422
+ # * {Types::GetKxEnvironmentResponse#aws_account_id #aws_account_id} => String
1423
+ # * {Types::GetKxEnvironmentResponse#status #status} => String
1424
+ # * {Types::GetKxEnvironmentResponse#tgw_status #tgw_status} => String
1425
+ # * {Types::GetKxEnvironmentResponse#dns_status #dns_status} => String
1426
+ # * {Types::GetKxEnvironmentResponse#error_message #error_message} => String
1427
+ # * {Types::GetKxEnvironmentResponse#description #description} => String
1428
+ # * {Types::GetKxEnvironmentResponse#environment_arn #environment_arn} => String
1429
+ # * {Types::GetKxEnvironmentResponse#kms_key_id #kms_key_id} => String
1430
+ # * {Types::GetKxEnvironmentResponse#dedicated_service_account_id #dedicated_service_account_id} => String
1431
+ # * {Types::GetKxEnvironmentResponse#transit_gateway_configuration #transit_gateway_configuration} => Types::TransitGatewayConfiguration
1432
+ # * {Types::GetKxEnvironmentResponse#custom_dns_configuration #custom_dns_configuration} => Array&lt;Types::CustomDNSServer&gt;
1433
+ # * {Types::GetKxEnvironmentResponse#creation_timestamp #creation_timestamp} => Time
1434
+ # * {Types::GetKxEnvironmentResponse#update_timestamp #update_timestamp} => Time
1435
+ # * {Types::GetKxEnvironmentResponse#availability_zone_ids #availability_zone_ids} => Array&lt;String&gt;
1436
+ # * {Types::GetKxEnvironmentResponse#certificate_authority_arn #certificate_authority_arn} => String
1437
+ #
1438
+ # @example Request syntax with placeholder values
1439
+ #
1440
+ # resp = client.get_kx_environment({
1441
+ # environment_id: "IdType", # required
1442
+ # })
1443
+ #
1444
+ # @example Response structure
1445
+ #
1446
+ # resp.name #=> String
1447
+ # resp.environment_id #=> String
1448
+ # resp.aws_account_id #=> String
1449
+ # resp.status #=> String, one of "CREATE_REQUESTED", "CREATING", "CREATED", "DELETE_REQUESTED", "DELETING", "DELETED", "FAILED_CREATION", "RETRY_DELETION", "FAILED_DELETION", "UPDATE_NETWORK_REQUESTED", "UPDATING_NETWORK", "FAILED_UPDATING_NETWORK", "SUSPENDED"
1450
+ # resp.tgw_status #=> String, one of "NONE", "UPDATE_REQUESTED", "UPDATING", "FAILED_UPDATE", "SUCCESSFULLY_UPDATED"
1451
+ # resp.dns_status #=> String, one of "NONE", "UPDATE_REQUESTED", "UPDATING", "FAILED_UPDATE", "SUCCESSFULLY_UPDATED"
1452
+ # resp.error_message #=> String
1453
+ # resp.description #=> String
1454
+ # resp.environment_arn #=> String
1455
+ # resp.kms_key_id #=> String
1456
+ # resp.dedicated_service_account_id #=> String
1457
+ # resp.transit_gateway_configuration.transit_gateway_id #=> String
1458
+ # resp.transit_gateway_configuration.routable_cidr_space #=> String
1459
+ # resp.custom_dns_configuration #=> Array
1460
+ # resp.custom_dns_configuration[0].custom_dns_server_name #=> String
1461
+ # resp.custom_dns_configuration[0].custom_dns_server_ip #=> String
1462
+ # resp.creation_timestamp #=> Time
1463
+ # resp.update_timestamp #=> Time
1464
+ # resp.availability_zone_ids #=> Array
1465
+ # resp.availability_zone_ids[0] #=> String
1466
+ # resp.certificate_authority_arn #=> String
1467
+ #
1468
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxEnvironment AWS API Documentation
1469
+ #
1470
+ # @overload get_kx_environment(params = {})
1471
+ # @param [Hash] params ({})
1472
+ def get_kx_environment(params = {}, options = {})
1473
+ req = build_request(:get_kx_environment, params)
1474
+ req.send_request(options)
1475
+ end
1476
+
1477
+ # Retrieves information about the specified kdb user.
1478
+ #
1479
+ # @option params [required, String] :user_name
1480
+ # A unique identifier for the user.
1481
+ #
1482
+ # @option params [required, String] :environment_id
1483
+ # A unique identifier for the kdb environment.
1484
+ #
1485
+ # @return [Types::GetKxUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1486
+ #
1487
+ # * {Types::GetKxUserResponse#user_name #user_name} => String
1488
+ # * {Types::GetKxUserResponse#user_arn #user_arn} => String
1489
+ # * {Types::GetKxUserResponse#environment_id #environment_id} => String
1490
+ # * {Types::GetKxUserResponse#iam_role #iam_role} => String
1491
+ #
1492
+ # @example Request syntax with placeholder values
1493
+ #
1494
+ # resp = client.get_kx_user({
1495
+ # user_name: "KxUserNameString", # required
1496
+ # environment_id: "IdType", # required
1497
+ # })
1498
+ #
1499
+ # @example Response structure
1500
+ #
1501
+ # resp.user_name #=> String
1502
+ # resp.user_arn #=> String
1503
+ # resp.environment_id #=> String
1504
+ # resp.iam_role #=> String
1505
+ #
1506
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxUser AWS API Documentation
1507
+ #
1508
+ # @overload get_kx_user(params = {})
1509
+ # @param [Hash] params ({})
1510
+ def get_kx_user(params = {}, options = {})
1511
+ req = build_request(:get_kx_user, params)
1512
+ req.send_request(options)
1513
+ end
1514
+
1515
+ # A list of all of your FinSpace environments.
1516
+ #
1517
+ # @option params [String] :next_token
1518
+ # A token generated by FinSpace that specifies where to continue
1519
+ # pagination if a previous request was truncated. To get the next set of
1520
+ # pages, pass in the `nextToken`nextToken value from the response object
1521
+ # of the previous page call.
1522
+ #
1523
+ # @option params [Integer] :max_results
1524
+ # The maximum number of results to return in this request.
1525
+ #
1526
+ # @return [Types::ListEnvironmentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1527
+ #
1528
+ # * {Types::ListEnvironmentsResponse#environments #environments} => Array&lt;Types::Environment&gt;
1529
+ # * {Types::ListEnvironmentsResponse#next_token #next_token} => String
1530
+ #
1531
+ # @example Request syntax with placeholder values
1532
+ #
1533
+ # resp = client.list_environments({
1534
+ # next_token: "PaginationToken",
1535
+ # max_results: 1,
1536
+ # })
1537
+ #
1538
+ # @example Response structure
1539
+ #
1540
+ # resp.environments #=> Array
1541
+ # resp.environments[0].name #=> String
1542
+ # resp.environments[0].environment_id #=> String
1543
+ # resp.environments[0].aws_account_id #=> String
1544
+ # resp.environments[0].status #=> String, one of "CREATE_REQUESTED", "CREATING", "CREATED", "DELETE_REQUESTED", "DELETING", "DELETED", "FAILED_CREATION", "RETRY_DELETION", "FAILED_DELETION", "UPDATE_NETWORK_REQUESTED", "UPDATING_NETWORK", "FAILED_UPDATING_NETWORK", "SUSPENDED"
1545
+ # resp.environments[0].environment_url #=> String
1546
+ # resp.environments[0].description #=> String
1547
+ # resp.environments[0].environment_arn #=> String
1548
+ # resp.environments[0].sage_maker_studio_domain_url #=> String
1549
+ # resp.environments[0].kms_key_id #=> String
1550
+ # resp.environments[0].dedicated_service_account_id #=> String
1551
+ # resp.environments[0].federation_mode #=> String, one of "FEDERATED", "LOCAL"
1552
+ # resp.environments[0].federation_parameters.saml_metadata_document #=> String
1553
+ # resp.environments[0].federation_parameters.saml_metadata_url #=> String
1554
+ # resp.environments[0].federation_parameters.application_call_back_url #=> String
1555
+ # resp.environments[0].federation_parameters.federation_urn #=> String
1556
+ # resp.environments[0].federation_parameters.federation_provider_name #=> String
1557
+ # resp.environments[0].federation_parameters.attribute_map #=> Hash
1558
+ # resp.environments[0].federation_parameters.attribute_map["FederationAttributeKey"] #=> String
1559
+ # resp.next_token #=> String
1560
+ #
1561
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListEnvironments AWS API Documentation
1562
+ #
1563
+ # @overload list_environments(params = {})
1564
+ # @param [Hash] params ({})
1565
+ def list_environments(params = {}, options = {})
1566
+ req = build_request(:list_environments, params)
1567
+ req.send_request(options)
1568
+ end
1569
+
1570
+ # Returns a list of all the changesets for a database.
1571
+ #
1572
+ # @option params [required, String] :environment_id
1573
+ # A unique identifier for the kdb environment.
1574
+ #
1575
+ # @option params [required, String] :database_name
1576
+ # The name of the kdb database.
1577
+ #
1578
+ # @option params [String] :next_token
1579
+ # A token that indicates where a results page should begin.
1580
+ #
1581
+ # @option params [Integer] :max_results
1582
+ # The maximum number of results to return in this request.
1583
+ #
1584
+ # @return [Types::ListKxChangesetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1585
+ #
1586
+ # * {Types::ListKxChangesetsResponse#kx_changesets #kx_changesets} => Array&lt;Types::KxChangesetListEntry&gt;
1587
+ # * {Types::ListKxChangesetsResponse#next_token #next_token} => String
1588
+ #
1589
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1590
+ #
1591
+ # @example Request syntax with placeholder values
1592
+ #
1593
+ # resp = client.list_kx_changesets({
1594
+ # environment_id: "EnvironmentId", # required
1595
+ # database_name: "DatabaseName", # required
1596
+ # next_token: "PaginationToken",
1597
+ # max_results: 1,
1598
+ # })
1599
+ #
1600
+ # @example Response structure
1601
+ #
1602
+ # resp.kx_changesets #=> Array
1603
+ # resp.kx_changesets[0].changeset_id #=> String
1604
+ # resp.kx_changesets[0].created_timestamp #=> Time
1605
+ # resp.kx_changesets[0].active_from_timestamp #=> Time
1606
+ # resp.kx_changesets[0].last_modified_timestamp #=> Time
1607
+ # resp.kx_changesets[0].status #=> String, one of "PENDING", "PROCESSING", "FAILED", "COMPLETED"
1608
+ # resp.next_token #=> String
1609
+ #
1610
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxChangesets AWS API Documentation
1611
+ #
1612
+ # @overload list_kx_changesets(params = {})
1613
+ # @param [Hash] params ({})
1614
+ def list_kx_changesets(params = {}, options = {})
1615
+ req = build_request(:list_kx_changesets, params)
1616
+ req.send_request(options)
1617
+ end
1618
+
1619
+ # Lists all the nodes in a kdb cluster.
1620
+ #
1621
+ # @option params [required, String] :environment_id
1622
+ # A unique identifier for the kdb environment.
1623
+ #
1624
+ # @option params [required, String] :cluster_name
1625
+ # A unique name for the cluster.
1626
+ #
1627
+ # @option params [String] :next_token
1628
+ # A token that indicates where a results page should begin.
1629
+ #
1630
+ # @option params [Integer] :max_results
1631
+ # The maximum number of results to return in this request.
1632
+ #
1633
+ # @return [Types::ListKxClusterNodesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1634
+ #
1635
+ # * {Types::ListKxClusterNodesResponse#nodes #nodes} => Array&lt;Types::KxNode&gt;
1636
+ # * {Types::ListKxClusterNodesResponse#next_token #next_token} => String
1637
+ #
1638
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1639
+ #
1640
+ # @example Request syntax with placeholder values
1641
+ #
1642
+ # resp = client.list_kx_cluster_nodes({
1643
+ # environment_id: "KxEnvironmentId", # required
1644
+ # cluster_name: "KxClusterName", # required
1645
+ # next_token: "PaginationToken",
1646
+ # max_results: 1,
1647
+ # })
1648
+ #
1649
+ # @example Response structure
1650
+ #
1651
+ # resp.nodes #=> Array
1652
+ # resp.nodes[0].node_id #=> String
1653
+ # resp.nodes[0].availability_zone_id #=> String
1654
+ # resp.nodes[0].launch_time #=> Time
1655
+ # resp.next_token #=> String
1656
+ #
1657
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxClusterNodes AWS API Documentation
1658
+ #
1659
+ # @overload list_kx_cluster_nodes(params = {})
1660
+ # @param [Hash] params ({})
1661
+ def list_kx_cluster_nodes(params = {}, options = {})
1662
+ req = build_request(:list_kx_cluster_nodes, params)
1663
+ req.send_request(options)
1664
+ end
1665
+
1666
+ # Returns a list of clusters.
1667
+ #
1668
+ # @option params [required, String] :environment_id
1669
+ # A unique identifier for the kdb environment.
1670
+ #
1671
+ # @option params [String] :cluster_type
1672
+ # Specifies the type of KDB database that is being created. The
1673
+ # following types are available:
1674
+ #
1675
+ # * HDB – A Historical Database. The data is only accessible with
1676
+ # read-only permissions from one of the FinSpace managed kdb databases
1677
+ # mounted to the cluster.
1678
+ #
1679
+ # * RDB – A Realtime Database. This type of database captures all the
1680
+ # data from a ticker plant and stores it in memory until the end of
1681
+ # day, after which it writes all of its data to a disk and reloads the
1682
+ # HDB. This cluster type requires local storage for temporary storage
1683
+ # of data during the savedown process. If you specify this field in
1684
+ # your request, you must provide the `savedownStorageConfiguration`
1685
+ # parameter.
1686
+ #
1687
+ # * GATEWAY – A gateway cluster allows you to access data across
1688
+ # processes in kdb systems. It allows you to create your own routing
1689
+ # logic using the initialization scripts and custom code. This type of
1690
+ # cluster does not require a writable local storage.
1691
+ #
1692
+ # @option params [Integer] :max_results
1693
+ # The maximum number of results to return in this request.
1694
+ #
1695
+ # @option params [String] :next_token
1696
+ # A token that indicates where a results page should begin.
1697
+ #
1698
+ # @return [Types::ListKxClustersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1699
+ #
1700
+ # * {Types::ListKxClustersResponse#kx_cluster_summaries #kx_cluster_summaries} => Array&lt;Types::KxCluster&gt;
1701
+ # * {Types::ListKxClustersResponse#next_token #next_token} => String
1702
+ #
1703
+ # @example Request syntax with placeholder values
1704
+ #
1705
+ # resp = client.list_kx_clusters({
1706
+ # environment_id: "KxEnvironmentId", # required
1707
+ # cluster_type: "HDB", # accepts HDB, RDB, GATEWAY
1708
+ # max_results: 1,
1709
+ # next_token: "PaginationToken",
1710
+ # })
1711
+ #
1712
+ # @example Response structure
1713
+ #
1714
+ # resp.kx_cluster_summaries #=> Array
1715
+ # resp.kx_cluster_summaries[0].status #=> String, one of "PENDING", "CREATING", "CREATE_FAILED", "RUNNING", "UPDATING", "DELETING", "DELETED", "DELETE_FAILED"
1716
+ # resp.kx_cluster_summaries[0].status_reason #=> String
1717
+ # resp.kx_cluster_summaries[0].cluster_name #=> String
1718
+ # resp.kx_cluster_summaries[0].cluster_type #=> String, one of "HDB", "RDB", "GATEWAY"
1719
+ # resp.kx_cluster_summaries[0].cluster_description #=> String
1720
+ # resp.kx_cluster_summaries[0].release_label #=> String
1721
+ # resp.kx_cluster_summaries[0].initialization_script #=> String
1722
+ # resp.kx_cluster_summaries[0].execution_role #=> String
1723
+ # resp.kx_cluster_summaries[0].az_mode #=> String, one of "SINGLE", "MULTI"
1724
+ # resp.kx_cluster_summaries[0].availability_zone_id #=> String
1725
+ # resp.kx_cluster_summaries[0].last_modified_timestamp #=> Time
1726
+ # resp.kx_cluster_summaries[0].created_timestamp #=> Time
1727
+ # resp.next_token #=> String
1728
+ #
1729
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxClusters AWS API Documentation
1730
+ #
1731
+ # @overload list_kx_clusters(params = {})
1732
+ # @param [Hash] params ({})
1733
+ def list_kx_clusters(params = {}, options = {})
1734
+ req = build_request(:list_kx_clusters, params)
1735
+ req.send_request(options)
1736
+ end
1737
+
1738
+ # Returns a list of all the databases in the kdb environment.
1739
+ #
1740
+ # @option params [required, String] :environment_id
1741
+ # A unique identifier for the kdb environment.
1742
+ #
1743
+ # @option params [String] :next_token
1744
+ # A token that indicates where a results page should begin.
1745
+ #
1746
+ # @option params [Integer] :max_results
1747
+ # The maximum number of results to return in this request.
1748
+ #
1749
+ # @return [Types::ListKxDatabasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1750
+ #
1751
+ # * {Types::ListKxDatabasesResponse#kx_databases #kx_databases} => Array&lt;Types::KxDatabaseListEntry&gt;
1752
+ # * {Types::ListKxDatabasesResponse#next_token #next_token} => String
1753
+ #
1754
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1755
+ #
1756
+ # @example Request syntax with placeholder values
1757
+ #
1758
+ # resp = client.list_kx_databases({
1759
+ # environment_id: "EnvironmentId", # required
1760
+ # next_token: "PaginationToken",
1761
+ # max_results: 1,
1762
+ # })
1763
+ #
1764
+ # @example Response structure
1765
+ #
1766
+ # resp.kx_databases #=> Array
1767
+ # resp.kx_databases[0].database_name #=> String
1768
+ # resp.kx_databases[0].created_timestamp #=> Time
1769
+ # resp.kx_databases[0].last_modified_timestamp #=> Time
1770
+ # resp.next_token #=> String
1771
+ #
1772
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxDatabases AWS API Documentation
1773
+ #
1774
+ # @overload list_kx_databases(params = {})
1775
+ # @param [Hash] params ({})
1776
+ def list_kx_databases(params = {}, options = {})
1777
+ req = build_request(:list_kx_databases, params)
1778
+ req.send_request(options)
1779
+ end
1780
+
1781
+ # Returns a list of kdb environments created in an account.
1782
+ #
1783
+ # @option params [String] :next_token
1784
+ # A token that indicates where a results page should begin.
1785
+ #
1786
+ # @option params [Integer] :max_results
1787
+ # The maximum number of results to return in this request.
1788
+ #
1789
+ # @return [Types::ListKxEnvironmentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1790
+ #
1791
+ # * {Types::ListKxEnvironmentsResponse#environments #environments} => Array&lt;Types::KxEnvironment&gt;
1792
+ # * {Types::ListKxEnvironmentsResponse#next_token #next_token} => String
1793
+ #
1794
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1795
+ #
1796
+ # @example Request syntax with placeholder values
1797
+ #
1798
+ # resp = client.list_kx_environments({
1799
+ # next_token: "PaginationToken",
1800
+ # max_results: 1,
1801
+ # })
1802
+ #
1803
+ # @example Response structure
1804
+ #
1805
+ # resp.environments #=> Array
1806
+ # resp.environments[0].name #=> String
1807
+ # resp.environments[0].environment_id #=> String
1808
+ # resp.environments[0].aws_account_id #=> String
1809
+ # resp.environments[0].status #=> String, one of "CREATE_REQUESTED", "CREATING", "CREATED", "DELETE_REQUESTED", "DELETING", "DELETED", "FAILED_CREATION", "RETRY_DELETION", "FAILED_DELETION", "UPDATE_NETWORK_REQUESTED", "UPDATING_NETWORK", "FAILED_UPDATING_NETWORK", "SUSPENDED"
1810
+ # resp.environments[0].tgw_status #=> String, one of "NONE", "UPDATE_REQUESTED", "UPDATING", "FAILED_UPDATE", "SUCCESSFULLY_UPDATED"
1811
+ # resp.environments[0].dns_status #=> String, one of "NONE", "UPDATE_REQUESTED", "UPDATING", "FAILED_UPDATE", "SUCCESSFULLY_UPDATED"
1812
+ # resp.environments[0].error_message #=> String
1813
+ # resp.environments[0].description #=> String
1814
+ # resp.environments[0].environment_arn #=> String
1815
+ # resp.environments[0].kms_key_id #=> String
1816
+ # resp.environments[0].dedicated_service_account_id #=> String
1817
+ # resp.environments[0].transit_gateway_configuration.transit_gateway_id #=> String
1818
+ # resp.environments[0].transit_gateway_configuration.routable_cidr_space #=> String
1819
+ # resp.environments[0].custom_dns_configuration #=> Array
1820
+ # resp.environments[0].custom_dns_configuration[0].custom_dns_server_name #=> String
1821
+ # resp.environments[0].custom_dns_configuration[0].custom_dns_server_ip #=> String
1822
+ # resp.environments[0].creation_timestamp #=> Time
1823
+ # resp.environments[0].update_timestamp #=> Time
1824
+ # resp.environments[0].availability_zone_ids #=> Array
1825
+ # resp.environments[0].availability_zone_ids[0] #=> String
1826
+ # resp.environments[0].certificate_authority_arn #=> String
1827
+ # resp.next_token #=> String
1828
+ #
1829
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxEnvironments AWS API Documentation
1830
+ #
1831
+ # @overload list_kx_environments(params = {})
1832
+ # @param [Hash] params ({})
1833
+ def list_kx_environments(params = {}, options = {})
1834
+ req = build_request(:list_kx_environments, params)
1835
+ req.send_request(options)
1836
+ end
1837
+
1838
+ # Lists all the users in a kdb environment.
1839
+ #
1840
+ # @option params [required, String] :environment_id
1841
+ # A unique identifier for the kdb environment.
1842
+ #
1843
+ # @option params [String] :next_token
1844
+ # A token that indicates where a results page should begin.
1845
+ #
1846
+ # @option params [Integer] :max_results
1847
+ # The maximum number of results to return in this request.
1848
+ #
1849
+ # @return [Types::ListKxUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1850
+ #
1851
+ # * {Types::ListKxUsersResponse#users #users} => Array&lt;Types::KxUser&gt;
1852
+ # * {Types::ListKxUsersResponse#next_token #next_token} => String
1853
+ #
1854
+ # @example Request syntax with placeholder values
1855
+ #
1856
+ # resp = client.list_kx_users({
1857
+ # environment_id: "IdType", # required
1858
+ # next_token: "PaginationToken",
1859
+ # max_results: 1,
1860
+ # })
1861
+ #
1862
+ # @example Response structure
1863
+ #
1864
+ # resp.users #=> Array
1865
+ # resp.users[0].user_arn #=> String
1866
+ # resp.users[0].user_name #=> String
1867
+ # resp.users[0].iam_role #=> String
1868
+ # resp.users[0].create_timestamp #=> Time
1869
+ # resp.users[0].update_timestamp #=> Time
1870
+ # resp.next_token #=> String
1871
+ #
1872
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxUsers AWS API Documentation
1873
+ #
1874
+ # @overload list_kx_users(params = {})
1875
+ # @param [Hash] params ({})
1876
+ def list_kx_users(params = {}, options = {})
1877
+ req = build_request(:list_kx_users, params)
1878
+ req.send_request(options)
1879
+ end
1880
+
1881
+ # A list of all tags for a resource.
1882
+ #
1883
+ # @option params [required, String] :resource_arn
1884
+ # The Amazon Resource Name of the resource.
1885
+ #
1886
+ # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1887
+ #
1888
+ # * {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt;
1889
+ #
1890
+ # @example Request syntax with placeholder values
1891
+ #
1892
+ # resp = client.list_tags_for_resource({
1893
+ # resource_arn: "FinSpaceTaggableArn", # required
1894
+ # })
1895
+ #
1896
+ # @example Response structure
1897
+ #
1898
+ # resp.tags #=> Hash
1899
+ # resp.tags["TagKey"] #=> String
1900
+ #
1901
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListTagsForResource AWS API Documentation
1902
+ #
1903
+ # @overload list_tags_for_resource(params = {})
1904
+ # @param [Hash] params ({})
1905
+ def list_tags_for_resource(params = {}, options = {})
1906
+ req = build_request(:list_tags_for_resource, params)
1907
+ req.send_request(options)
1908
+ end
1909
+
1910
+ # Adds metadata tags to a FinSpace resource.
1911
+ #
1912
+ # @option params [required, String] :resource_arn
1913
+ # The Amazon Resource Name (ARN) for the resource.
1914
+ #
1915
+ # @option params [required, Hash<String,String>] :tags
1916
+ # One or more tags to be assigned to the resource.
1917
+ #
1918
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1919
+ #
1920
+ # @example Request syntax with placeholder values
1921
+ #
1922
+ # resp = client.tag_resource({
1923
+ # resource_arn: "FinSpaceTaggableArn", # required
1924
+ # tags: { # required
1925
+ # "TagKey" => "TagValue",
1926
+ # },
1927
+ # })
1928
+ #
1929
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/TagResource AWS API Documentation
1930
+ #
1931
+ # @overload tag_resource(params = {})
1932
+ # @param [Hash] params ({})
1933
+ def tag_resource(params = {}, options = {})
1934
+ req = build_request(:tag_resource, params)
1935
+ req.send_request(options)
1936
+ end
1937
+
1938
+ # Removes metadata tags from a FinSpace resource.
1939
+ #
1940
+ # @option params [required, String] :resource_arn
1941
+ # A FinSpace resource from which you want to remove a tag or tags. The
1942
+ # value for this parameter is an Amazon Resource Name (ARN).
1943
+ #
1944
+ # @option params [required, Array<String>] :tag_keys
1945
+ # The tag keys (names) of one or more tags to be removed.
1946
+ #
1947
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1948
+ #
1949
+ # @example Request syntax with placeholder values
1950
+ #
1951
+ # resp = client.untag_resource({
1952
+ # resource_arn: "FinSpaceTaggableArn", # required
1953
+ # tag_keys: ["TagKey"], # required
1954
+ # })
1955
+ #
1956
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UntagResource AWS API Documentation
1957
+ #
1958
+ # @overload untag_resource(params = {})
1959
+ # @param [Hash] params ({})
1960
+ def untag_resource(params = {}, options = {})
1961
+ req = build_request(:untag_resource, params)
1962
+ req.send_request(options)
1963
+ end
1964
+
1965
+ # Update your FinSpace environment.
1966
+ #
1967
+ # @option params [required, String] :environment_id
1968
+ # The identifier of the FinSpace environment.
1969
+ #
1970
+ # @option params [String] :name
1971
+ # The name of the environment.
1972
+ #
1973
+ # @option params [String] :description
1974
+ # The description of the environment.
1975
+ #
1976
+ # @option params [String] :federation_mode
1977
+ # Authentication mode for the environment.
1978
+ #
1979
+ # * `FEDERATED` - Users access FinSpace through Single Sign On (SSO) via
1980
+ # your Identity provider.
1981
+ #
1982
+ # * `LOCAL` - Users access FinSpace via email and password managed
1983
+ # within the FinSpace environment.
1984
+ #
1985
+ # @option params [Types::FederationParameters] :federation_parameters
1986
+ # Configuration information when authentication mode is FEDERATED.
1987
+ #
1988
+ # @return [Types::UpdateEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1989
+ #
1990
+ # * {Types::UpdateEnvironmentResponse#environment #environment} => Types::Environment
1991
+ #
1992
+ # @example Request syntax with placeholder values
1993
+ #
1994
+ # resp = client.update_environment({
1995
+ # environment_id: "IdType", # required
1996
+ # name: "EnvironmentName",
1997
+ # description: "Description",
1998
+ # federation_mode: "FEDERATED", # accepts FEDERATED, LOCAL
1999
+ # federation_parameters: {
2000
+ # saml_metadata_document: "SamlMetadataDocument",
2001
+ # saml_metadata_url: "url",
2002
+ # application_call_back_url: "url",
2003
+ # federation_urn: "urn",
2004
+ # federation_provider_name: "FederationProviderName",
2005
+ # attribute_map: {
2006
+ # "FederationAttributeKey" => "FederationAttributeValue",
2007
+ # },
2008
+ # },
2009
+ # })
2010
+ #
2011
+ # @example Response structure
2012
+ #
2013
+ # resp.environment.name #=> String
2014
+ # resp.environment.environment_id #=> String
2015
+ # resp.environment.aws_account_id #=> String
2016
+ # resp.environment.status #=> String, one of "CREATE_REQUESTED", "CREATING", "CREATED", "DELETE_REQUESTED", "DELETING", "DELETED", "FAILED_CREATION", "RETRY_DELETION", "FAILED_DELETION", "UPDATE_NETWORK_REQUESTED", "UPDATING_NETWORK", "FAILED_UPDATING_NETWORK", "SUSPENDED"
2017
+ # resp.environment.environment_url #=> String
2018
+ # resp.environment.description #=> String
722
2019
  # resp.environment.environment_arn #=> String
723
2020
  # resp.environment.sage_maker_studio_domain_url #=> String
724
2021
  # resp.environment.kms_key_id #=> String
@@ -741,6 +2038,318 @@ module Aws::Finspace
741
2038
  req.send_request(options)
742
2039
  end
743
2040
 
2041
+ # Updates the databases mounted on a kdb cluster, which includes the
2042
+ # `changesetId` and all the dbPaths to be cached. This API does not
2043
+ # allow you to change a database name or add a database if you created a
2044
+ # cluster without one.
2045
+ #
2046
+ # Using this API you can point a cluster to a different changeset and
2047
+ # modify a list of partitions being cached.
2048
+ #
2049
+ # @option params [required, String] :environment_id
2050
+ # The unique identifier of a kdb environment.
2051
+ #
2052
+ # @option params [required, String] :cluster_name
2053
+ # A unique name for the cluster that you want to modify.
2054
+ #
2055
+ # @option params [String] :client_token
2056
+ # A token that ensures idempotency. This token expires in 10 minutes.
2057
+ #
2058
+ # @option params [required, Array<Types::KxDatabaseConfiguration>] :databases
2059
+ # The structure of databases mounted on the cluster.
2060
+ #
2061
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2062
+ #
2063
+ # @example Request syntax with placeholder values
2064
+ #
2065
+ # resp = client.update_kx_cluster_databases({
2066
+ # environment_id: "KxEnvironmentId", # required
2067
+ # cluster_name: "KxClusterName", # required
2068
+ # client_token: "ClientTokenString",
2069
+ # databases: [ # required
2070
+ # {
2071
+ # database_name: "DatabaseName", # required
2072
+ # cache_configurations: [
2073
+ # {
2074
+ # cache_type: "KxCacheStorageType", # required
2075
+ # db_paths: ["DbPath"], # required
2076
+ # },
2077
+ # ],
2078
+ # changeset_id: "ChangesetId",
2079
+ # },
2080
+ # ],
2081
+ # })
2082
+ #
2083
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxClusterDatabases AWS API Documentation
2084
+ #
2085
+ # @overload update_kx_cluster_databases(params = {})
2086
+ # @param [Hash] params ({})
2087
+ def update_kx_cluster_databases(params = {}, options = {})
2088
+ req = build_request(:update_kx_cluster_databases, params)
2089
+ req.send_request(options)
2090
+ end
2091
+
2092
+ # Updates information for the given kdb database.
2093
+ #
2094
+ # @option params [required, String] :environment_id
2095
+ # A unique identifier for the kdb environment.
2096
+ #
2097
+ # @option params [required, String] :database_name
2098
+ # The name of the kdb database.
2099
+ #
2100
+ # @option params [String] :description
2101
+ # A description of the database.
2102
+ #
2103
+ # @option params [required, String] :client_token
2104
+ # A token that ensures idempotency. This token expires in 10 minutes.
2105
+ #
2106
+ # **A suitable default value is auto-generated.** You should normally
2107
+ # not need to pass this option.**
2108
+ #
2109
+ # @return [Types::UpdateKxDatabaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2110
+ #
2111
+ # * {Types::UpdateKxDatabaseResponse#database_name #database_name} => String
2112
+ # * {Types::UpdateKxDatabaseResponse#environment_id #environment_id} => String
2113
+ # * {Types::UpdateKxDatabaseResponse#description #description} => String
2114
+ # * {Types::UpdateKxDatabaseResponse#last_modified_timestamp #last_modified_timestamp} => Time
2115
+ #
2116
+ # @example Request syntax with placeholder values
2117
+ #
2118
+ # resp = client.update_kx_database({
2119
+ # environment_id: "EnvironmentId", # required
2120
+ # database_name: "DatabaseName", # required
2121
+ # description: "Description",
2122
+ # client_token: "ClientTokenString", # required
2123
+ # })
2124
+ #
2125
+ # @example Response structure
2126
+ #
2127
+ # resp.database_name #=> String
2128
+ # resp.environment_id #=> String
2129
+ # resp.description #=> String
2130
+ # resp.last_modified_timestamp #=> Time
2131
+ #
2132
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxDatabase AWS API Documentation
2133
+ #
2134
+ # @overload update_kx_database(params = {})
2135
+ # @param [Hash] params ({})
2136
+ def update_kx_database(params = {}, options = {})
2137
+ req = build_request(:update_kx_database, params)
2138
+ req.send_request(options)
2139
+ end
2140
+
2141
+ # Updates information for the given kdb environment.
2142
+ #
2143
+ # @option params [required, String] :environment_id
2144
+ # A unique identifier for the kdb environment.
2145
+ #
2146
+ # @option params [String] :name
2147
+ # The name of the kdb environment.
2148
+ #
2149
+ # @option params [String] :description
2150
+ # A description of the kdb environment.
2151
+ #
2152
+ # @option params [String] :client_token
2153
+ # A token that ensures idempotency. This token expires in 10 minutes.
2154
+ #
2155
+ # @return [Types::UpdateKxEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2156
+ #
2157
+ # * {Types::UpdateKxEnvironmentResponse#name #name} => String
2158
+ # * {Types::UpdateKxEnvironmentResponse#environment_id #environment_id} => String
2159
+ # * {Types::UpdateKxEnvironmentResponse#aws_account_id #aws_account_id} => String
2160
+ # * {Types::UpdateKxEnvironmentResponse#status #status} => String
2161
+ # * {Types::UpdateKxEnvironmentResponse#tgw_status #tgw_status} => String
2162
+ # * {Types::UpdateKxEnvironmentResponse#dns_status #dns_status} => String
2163
+ # * {Types::UpdateKxEnvironmentResponse#error_message #error_message} => String
2164
+ # * {Types::UpdateKxEnvironmentResponse#description #description} => String
2165
+ # * {Types::UpdateKxEnvironmentResponse#environment_arn #environment_arn} => String
2166
+ # * {Types::UpdateKxEnvironmentResponse#kms_key_id #kms_key_id} => String
2167
+ # * {Types::UpdateKxEnvironmentResponse#dedicated_service_account_id #dedicated_service_account_id} => String
2168
+ # * {Types::UpdateKxEnvironmentResponse#transit_gateway_configuration #transit_gateway_configuration} => Types::TransitGatewayConfiguration
2169
+ # * {Types::UpdateKxEnvironmentResponse#custom_dns_configuration #custom_dns_configuration} => Array&lt;Types::CustomDNSServer&gt;
2170
+ # * {Types::UpdateKxEnvironmentResponse#creation_timestamp #creation_timestamp} => Time
2171
+ # * {Types::UpdateKxEnvironmentResponse#update_timestamp #update_timestamp} => Time
2172
+ # * {Types::UpdateKxEnvironmentResponse#availability_zone_ids #availability_zone_ids} => Array&lt;String&gt;
2173
+ #
2174
+ # @example Request syntax with placeholder values
2175
+ #
2176
+ # resp = client.update_kx_environment({
2177
+ # environment_id: "IdType", # required
2178
+ # name: "KxEnvironmentName",
2179
+ # description: "Description",
2180
+ # client_token: "ClientToken",
2181
+ # })
2182
+ #
2183
+ # @example Response structure
2184
+ #
2185
+ # resp.name #=> String
2186
+ # resp.environment_id #=> String
2187
+ # resp.aws_account_id #=> String
2188
+ # resp.status #=> String, one of "CREATE_REQUESTED", "CREATING", "CREATED", "DELETE_REQUESTED", "DELETING", "DELETED", "FAILED_CREATION", "RETRY_DELETION", "FAILED_DELETION", "UPDATE_NETWORK_REQUESTED", "UPDATING_NETWORK", "FAILED_UPDATING_NETWORK", "SUSPENDED"
2189
+ # resp.tgw_status #=> String, one of "NONE", "UPDATE_REQUESTED", "UPDATING", "FAILED_UPDATE", "SUCCESSFULLY_UPDATED"
2190
+ # resp.dns_status #=> String, one of "NONE", "UPDATE_REQUESTED", "UPDATING", "FAILED_UPDATE", "SUCCESSFULLY_UPDATED"
2191
+ # resp.error_message #=> String
2192
+ # resp.description #=> String
2193
+ # resp.environment_arn #=> String
2194
+ # resp.kms_key_id #=> String
2195
+ # resp.dedicated_service_account_id #=> String
2196
+ # resp.transit_gateway_configuration.transit_gateway_id #=> String
2197
+ # resp.transit_gateway_configuration.routable_cidr_space #=> String
2198
+ # resp.custom_dns_configuration #=> Array
2199
+ # resp.custom_dns_configuration[0].custom_dns_server_name #=> String
2200
+ # resp.custom_dns_configuration[0].custom_dns_server_ip #=> String
2201
+ # resp.creation_timestamp #=> Time
2202
+ # resp.update_timestamp #=> Time
2203
+ # resp.availability_zone_ids #=> Array
2204
+ # resp.availability_zone_ids[0] #=> String
2205
+ #
2206
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxEnvironment AWS API Documentation
2207
+ #
2208
+ # @overload update_kx_environment(params = {})
2209
+ # @param [Hash] params ({})
2210
+ def update_kx_environment(params = {}, options = {})
2211
+ req = build_request(:update_kx_environment, params)
2212
+ req.send_request(options)
2213
+ end
2214
+
2215
+ # Updates environment network to connect to your internal network by
2216
+ # using a transit gateway. This API supports request to create a transit
2217
+ # gateway attachment from FinSpace VPC to your transit gateway ID and
2218
+ # create a custom Route-53 outbound resolvers.
2219
+ #
2220
+ # Once you send a request to update a network, you cannot change it
2221
+ # again. Network update might require termination of any clusters that
2222
+ # are running in the existing network.
2223
+ #
2224
+ # @option params [required, String] :environment_id
2225
+ # A unique identifier for the kdb environment.
2226
+ #
2227
+ # @option params [Types::TransitGatewayConfiguration] :transit_gateway_configuration
2228
+ # Specifies the transit gateway and network configuration to connect the
2229
+ # kdb environment to an internal network.
2230
+ #
2231
+ # @option params [Array<Types::CustomDNSServer>] :custom_dns_configuration
2232
+ # A list of DNS server name and server IP. This is used to set up
2233
+ # Route-53 outbound resolvers.
2234
+ #
2235
+ # @option params [String] :client_token
2236
+ # A token that ensures idempotency. This token expires in 10 minutes.
2237
+ #
2238
+ # @return [Types::UpdateKxEnvironmentNetworkResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2239
+ #
2240
+ # * {Types::UpdateKxEnvironmentNetworkResponse#name #name} => String
2241
+ # * {Types::UpdateKxEnvironmentNetworkResponse#environment_id #environment_id} => String
2242
+ # * {Types::UpdateKxEnvironmentNetworkResponse#aws_account_id #aws_account_id} => String
2243
+ # * {Types::UpdateKxEnvironmentNetworkResponse#status #status} => String
2244
+ # * {Types::UpdateKxEnvironmentNetworkResponse#tgw_status #tgw_status} => String
2245
+ # * {Types::UpdateKxEnvironmentNetworkResponse#dns_status #dns_status} => String
2246
+ # * {Types::UpdateKxEnvironmentNetworkResponse#error_message #error_message} => String
2247
+ # * {Types::UpdateKxEnvironmentNetworkResponse#description #description} => String
2248
+ # * {Types::UpdateKxEnvironmentNetworkResponse#environment_arn #environment_arn} => String
2249
+ # * {Types::UpdateKxEnvironmentNetworkResponse#kms_key_id #kms_key_id} => String
2250
+ # * {Types::UpdateKxEnvironmentNetworkResponse#dedicated_service_account_id #dedicated_service_account_id} => String
2251
+ # * {Types::UpdateKxEnvironmentNetworkResponse#transit_gateway_configuration #transit_gateway_configuration} => Types::TransitGatewayConfiguration
2252
+ # * {Types::UpdateKxEnvironmentNetworkResponse#custom_dns_configuration #custom_dns_configuration} => Array&lt;Types::CustomDNSServer&gt;
2253
+ # * {Types::UpdateKxEnvironmentNetworkResponse#creation_timestamp #creation_timestamp} => Time
2254
+ # * {Types::UpdateKxEnvironmentNetworkResponse#update_timestamp #update_timestamp} => Time
2255
+ # * {Types::UpdateKxEnvironmentNetworkResponse#availability_zone_ids #availability_zone_ids} => Array&lt;String&gt;
2256
+ #
2257
+ # @example Request syntax with placeholder values
2258
+ #
2259
+ # resp = client.update_kx_environment_network({
2260
+ # environment_id: "IdType", # required
2261
+ # transit_gateway_configuration: {
2262
+ # transit_gateway_id: "TransitGatewayID", # required
2263
+ # routable_cidr_space: "ValidCIDRSpace", # required
2264
+ # },
2265
+ # custom_dns_configuration: [
2266
+ # {
2267
+ # custom_dns_server_name: "ValidHostname", # required
2268
+ # custom_dns_server_ip: "ValidIPAddress", # required
2269
+ # },
2270
+ # ],
2271
+ # client_token: "ClientToken",
2272
+ # })
2273
+ #
2274
+ # @example Response structure
2275
+ #
2276
+ # resp.name #=> String
2277
+ # resp.environment_id #=> String
2278
+ # resp.aws_account_id #=> String
2279
+ # resp.status #=> String, one of "CREATE_REQUESTED", "CREATING", "CREATED", "DELETE_REQUESTED", "DELETING", "DELETED", "FAILED_CREATION", "RETRY_DELETION", "FAILED_DELETION", "UPDATE_NETWORK_REQUESTED", "UPDATING_NETWORK", "FAILED_UPDATING_NETWORK", "SUSPENDED"
2280
+ # resp.tgw_status #=> String, one of "NONE", "UPDATE_REQUESTED", "UPDATING", "FAILED_UPDATE", "SUCCESSFULLY_UPDATED"
2281
+ # resp.dns_status #=> String, one of "NONE", "UPDATE_REQUESTED", "UPDATING", "FAILED_UPDATE", "SUCCESSFULLY_UPDATED"
2282
+ # resp.error_message #=> String
2283
+ # resp.description #=> String
2284
+ # resp.environment_arn #=> String
2285
+ # resp.kms_key_id #=> String
2286
+ # resp.dedicated_service_account_id #=> String
2287
+ # resp.transit_gateway_configuration.transit_gateway_id #=> String
2288
+ # resp.transit_gateway_configuration.routable_cidr_space #=> String
2289
+ # resp.custom_dns_configuration #=> Array
2290
+ # resp.custom_dns_configuration[0].custom_dns_server_name #=> String
2291
+ # resp.custom_dns_configuration[0].custom_dns_server_ip #=> String
2292
+ # resp.creation_timestamp #=> Time
2293
+ # resp.update_timestamp #=> Time
2294
+ # resp.availability_zone_ids #=> Array
2295
+ # resp.availability_zone_ids[0] #=> String
2296
+ #
2297
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxEnvironmentNetwork AWS API Documentation
2298
+ #
2299
+ # @overload update_kx_environment_network(params = {})
2300
+ # @param [Hash] params ({})
2301
+ def update_kx_environment_network(params = {}, options = {})
2302
+ req = build_request(:update_kx_environment_network, params)
2303
+ req.send_request(options)
2304
+ end
2305
+
2306
+ # Updates the user details. You can only update the IAM role associated
2307
+ # with a user.
2308
+ #
2309
+ # @option params [required, String] :environment_id
2310
+ # A unique identifier for the kdb environment.
2311
+ #
2312
+ # @option params [required, String] :user_name
2313
+ # A unique identifier for the user.
2314
+ #
2315
+ # @option params [required, String] :iam_role
2316
+ # The IAM role ARN that is associated with the user.
2317
+ #
2318
+ # @option params [String] :client_token
2319
+ # A token that ensures idempotency. This token expires in 10 minutes.
2320
+ #
2321
+ # @return [Types::UpdateKxUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2322
+ #
2323
+ # * {Types::UpdateKxUserResponse#user_name #user_name} => String
2324
+ # * {Types::UpdateKxUserResponse#user_arn #user_arn} => String
2325
+ # * {Types::UpdateKxUserResponse#environment_id #environment_id} => String
2326
+ # * {Types::UpdateKxUserResponse#iam_role #iam_role} => String
2327
+ #
2328
+ # @example Request syntax with placeholder values
2329
+ #
2330
+ # resp = client.update_kx_user({
2331
+ # environment_id: "IdType", # required
2332
+ # user_name: "KxUserNameString", # required
2333
+ # iam_role: "RoleArn", # required
2334
+ # client_token: "ClientToken",
2335
+ # })
2336
+ #
2337
+ # @example Response structure
2338
+ #
2339
+ # resp.user_name #=> String
2340
+ # resp.user_arn #=> String
2341
+ # resp.environment_id #=> String
2342
+ # resp.iam_role #=> String
2343
+ #
2344
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxUser AWS API Documentation
2345
+ #
2346
+ # @overload update_kx_user(params = {})
2347
+ # @param [Hash] params ({})
2348
+ def update_kx_user(params = {}, options = {})
2349
+ req = build_request(:update_kx_user, params)
2350
+ req.send_request(options)
2351
+ end
2352
+
744
2353
  # @!endgroup
745
2354
 
746
2355
  # @param params ({})
@@ -754,7 +2363,7 @@ module Aws::Finspace
754
2363
  params: params,
755
2364
  config: config)
756
2365
  context[:gem_name] = 'aws-sdk-finspace'
757
- context[:gem_version] = '1.13.0'
2366
+ context[:gem_version] = '1.15.0'
758
2367
  Seahorse::Client::Request.new(handlers, context)
759
2368
  end
760
2369