aws-sdk-finspace 1.26.0 → 1.27.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-finspace/client.rb +1094 -12
- data/lib/aws-sdk-finspace/client_api.rb +640 -9
- data/lib/aws-sdk-finspace/endpoints.rb +196 -0
- data/lib/aws-sdk-finspace/plugins/endpoints.rb +28 -0
- data/lib/aws-sdk-finspace/types.rb +2010 -123
- data/lib/aws-sdk-finspace.rb +1 -1
- metadata +2 -2
@@ -634,6 +634,18 @@ module Aws::Finspace
|
|
634
634
|
# this cluster type, the node count is fixed at 1. It does not support
|
635
635
|
# autoscaling and supports only `SINGLE` AZ mode.
|
636
636
|
#
|
637
|
+
# * Tickerplant – A tickerplant cluster allows you to subscribe to feed
|
638
|
+
# handlers based on IAM permissions. It can publish to RDBs, other
|
639
|
+
# Tickerplants, and real-time subscribers (RTS). Tickerplants can
|
640
|
+
# persist messages to log, which is readable by any RDB environment.
|
641
|
+
# It supports only single-node that is only one kdb process.
|
642
|
+
#
|
643
|
+
# @option params [Types::TickerplantLogConfiguration] :tickerplant_log_configuration
|
644
|
+
# A configuration to store Tickerplant logs. It consists of a list of
|
645
|
+
# volumes that will be mounted to your cluster. For the cluster type
|
646
|
+
# `Tickerplant`, the location of the TP volume on the cluster will be
|
647
|
+
# available by using the global variable `.aws.tp_log_path`.
|
648
|
+
#
|
637
649
|
# @option params [Array<Types::KxDatabaseConfiguration>] :databases
|
638
650
|
# A list of databases that will be available for querying.
|
639
651
|
#
|
@@ -649,14 +661,14 @@ module Aws::Finspace
|
|
649
661
|
# @option params [String] :cluster_description
|
650
662
|
# A description of the cluster.
|
651
663
|
#
|
652
|
-
# @option params [
|
664
|
+
# @option params [Types::CapacityConfiguration] :capacity_configuration
|
653
665
|
# A structure for the metadata of a cluster. It includes information
|
654
666
|
# like the CPUs needed, memory of instances, and number of instances.
|
655
667
|
#
|
656
668
|
# @option params [required, String] :release_label
|
657
669
|
# The version of FinSpace managed kdb to run.
|
658
670
|
#
|
659
|
-
# @option params [Types::VpcConfiguration] :vpc_configuration
|
671
|
+
# @option params [required, Types::VpcConfiguration] :vpc_configuration
|
660
672
|
# Configuration details about the network where the Privatelink endpoint
|
661
673
|
# of the cluster resides.
|
662
674
|
#
|
@@ -701,6 +713,10 @@ module Aws::Finspace
|
|
701
713
|
# A list of key-value pairs to label the cluster. You can add up to 50
|
702
714
|
# tags to a cluster.
|
703
715
|
#
|
716
|
+
# @option params [Types::KxScalingGroupConfiguration] :scaling_group_configuration
|
717
|
+
# The structure that stores the configuration details of a scaling
|
718
|
+
# group.
|
719
|
+
#
|
704
720
|
# @return [Types::CreateKxClusterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
705
721
|
#
|
706
722
|
# * {Types::CreateKxClusterResponse#environment_id #environment_id} => String
|
@@ -708,6 +724,8 @@ module Aws::Finspace
|
|
708
724
|
# * {Types::CreateKxClusterResponse#status_reason #status_reason} => String
|
709
725
|
# * {Types::CreateKxClusterResponse#cluster_name #cluster_name} => String
|
710
726
|
# * {Types::CreateKxClusterResponse#cluster_type #cluster_type} => String
|
727
|
+
# * {Types::CreateKxClusterResponse#tickerplant_log_configuration #tickerplant_log_configuration} => Types::TickerplantLogConfiguration
|
728
|
+
# * {Types::CreateKxClusterResponse#volumes #volumes} => Array<Types::Volume>
|
711
729
|
# * {Types::CreateKxClusterResponse#databases #databases} => Array<Types::KxDatabaseConfiguration>
|
712
730
|
# * {Types::CreateKxClusterResponse#cache_storage_configurations #cache_storage_configurations} => Array<Types::KxCacheStorageConfiguration>
|
713
731
|
# * {Types::CreateKxClusterResponse#auto_scaling_configuration #auto_scaling_configuration} => Types::AutoScalingConfiguration
|
@@ -724,6 +742,7 @@ module Aws::Finspace
|
|
724
742
|
# * {Types::CreateKxClusterResponse#az_mode #az_mode} => String
|
725
743
|
# * {Types::CreateKxClusterResponse#availability_zone_id #availability_zone_id} => String
|
726
744
|
# * {Types::CreateKxClusterResponse#created_timestamp #created_timestamp} => Time
|
745
|
+
# * {Types::CreateKxClusterResponse#scaling_group_configuration #scaling_group_configuration} => Types::KxScalingGroupConfiguration
|
727
746
|
#
|
728
747
|
# @example Request syntax with placeholder values
|
729
748
|
#
|
@@ -731,7 +750,10 @@ module Aws::Finspace
|
|
731
750
|
# client_token: "ClientToken",
|
732
751
|
# environment_id: "KxEnvironmentId", # required
|
733
752
|
# cluster_name: "KxClusterName", # required
|
734
|
-
# cluster_type: "HDB", # required, accepts HDB, RDB, GATEWAY, GP
|
753
|
+
# cluster_type: "HDB", # required, accepts HDB, RDB, GATEWAY, GP, TICKERPLANT
|
754
|
+
# tickerplant_log_configuration: {
|
755
|
+
# tickerplant_log_volumes: ["VolumeName"],
|
756
|
+
# },
|
735
757
|
# databases: [
|
736
758
|
# {
|
737
759
|
# database_name: "DatabaseName", # required
|
@@ -739,9 +761,22 @@ module Aws::Finspace
|
|
739
761
|
# {
|
740
762
|
# cache_type: "KxCacheStorageType", # required
|
741
763
|
# db_paths: ["DbPath"], # required
|
764
|
+
# dataview_name: "KxDataviewName",
|
742
765
|
# },
|
743
766
|
# ],
|
744
767
|
# changeset_id: "ChangesetId",
|
768
|
+
# dataview_name: "KxDataviewName",
|
769
|
+
# dataview_configuration: {
|
770
|
+
# dataview_name: "KxDataviewName",
|
771
|
+
# dataview_version_id: "VersionId",
|
772
|
+
# changeset_id: "ChangesetId",
|
773
|
+
# segment_configurations: [
|
774
|
+
# {
|
775
|
+
# db_paths: ["DbPath"], # required
|
776
|
+
# volume_name: "KxVolumeName", # required
|
777
|
+
# },
|
778
|
+
# ],
|
779
|
+
# },
|
745
780
|
# },
|
746
781
|
# ],
|
747
782
|
# cache_storage_configurations: [
|
@@ -759,12 +794,12 @@ module Aws::Finspace
|
|
759
794
|
# scale_out_cooldown_seconds: 1.0,
|
760
795
|
# },
|
761
796
|
# cluster_description: "KxClusterDescription",
|
762
|
-
# capacity_configuration: {
|
797
|
+
# capacity_configuration: {
|
763
798
|
# node_type: "NodeType",
|
764
799
|
# node_count: 1,
|
765
800
|
# },
|
766
801
|
# release_label: "ReleaseLabel", # required
|
767
|
-
# vpc_configuration: {
|
802
|
+
# vpc_configuration: { # required
|
768
803
|
# vpc_id: "VpcIdString",
|
769
804
|
# security_group_ids: ["SecurityGroupIdString"],
|
770
805
|
# subnet_ids: ["SubnetIdString"],
|
@@ -784,14 +819,22 @@ module Aws::Finspace
|
|
784
819
|
# },
|
785
820
|
# execution_role: "ExecutionRoleArn",
|
786
821
|
# savedown_storage_configuration: {
|
787
|
-
# type: "SDS01", #
|
788
|
-
# size: 1,
|
822
|
+
# type: "SDS01", # accepts SDS01
|
823
|
+
# size: 1,
|
824
|
+
# volume_name: "KxVolumeName",
|
789
825
|
# },
|
790
826
|
# az_mode: "SINGLE", # required, accepts SINGLE, MULTI
|
791
827
|
# availability_zone_id: "AvailabilityZoneId",
|
792
828
|
# tags: {
|
793
829
|
# "TagKey" => "TagValue",
|
794
830
|
# },
|
831
|
+
# scaling_group_configuration: {
|
832
|
+
# scaling_group_name: "KxScalingGroupName", # required
|
833
|
+
# memory_limit: 1,
|
834
|
+
# memory_reservation: 1, # required
|
835
|
+
# node_count: 1, # required
|
836
|
+
# cpu: 1.0,
|
837
|
+
# },
|
795
838
|
# })
|
796
839
|
#
|
797
840
|
# @example Response structure
|
@@ -800,14 +843,28 @@ module Aws::Finspace
|
|
800
843
|
# resp.status #=> String, one of "PENDING", "CREATING", "CREATE_FAILED", "RUNNING", "UPDATING", "DELETING", "DELETED", "DELETE_FAILED"
|
801
844
|
# resp.status_reason #=> String
|
802
845
|
# resp.cluster_name #=> String
|
803
|
-
# resp.cluster_type #=> String, one of "HDB", "RDB", "GATEWAY", "GP"
|
846
|
+
# resp.cluster_type #=> String, one of "HDB", "RDB", "GATEWAY", "GP", "TICKERPLANT"
|
847
|
+
# resp.tickerplant_log_configuration.tickerplant_log_volumes #=> Array
|
848
|
+
# resp.tickerplant_log_configuration.tickerplant_log_volumes[0] #=> String
|
849
|
+
# resp.volumes #=> Array
|
850
|
+
# resp.volumes[0].volume_name #=> String
|
851
|
+
# resp.volumes[0].volume_type #=> String, one of "NAS_1"
|
804
852
|
# resp.databases #=> Array
|
805
853
|
# resp.databases[0].database_name #=> String
|
806
854
|
# resp.databases[0].cache_configurations #=> Array
|
807
855
|
# resp.databases[0].cache_configurations[0].cache_type #=> String
|
808
856
|
# resp.databases[0].cache_configurations[0].db_paths #=> Array
|
809
857
|
# resp.databases[0].cache_configurations[0].db_paths[0] #=> String
|
858
|
+
# resp.databases[0].cache_configurations[0].dataview_name #=> String
|
810
859
|
# resp.databases[0].changeset_id #=> String
|
860
|
+
# resp.databases[0].dataview_name #=> String
|
861
|
+
# resp.databases[0].dataview_configuration.dataview_name #=> String
|
862
|
+
# resp.databases[0].dataview_configuration.dataview_version_id #=> String
|
863
|
+
# resp.databases[0].dataview_configuration.changeset_id #=> String
|
864
|
+
# resp.databases[0].dataview_configuration.segment_configurations #=> Array
|
865
|
+
# resp.databases[0].dataview_configuration.segment_configurations[0].db_paths #=> Array
|
866
|
+
# resp.databases[0].dataview_configuration.segment_configurations[0].db_paths[0] #=> String
|
867
|
+
# resp.databases[0].dataview_configuration.segment_configurations[0].volume_name #=> String
|
811
868
|
# resp.cache_storage_configurations #=> Array
|
812
869
|
# resp.cache_storage_configurations[0].type #=> String
|
813
870
|
# resp.cache_storage_configurations[0].size #=> Integer
|
@@ -838,9 +895,15 @@ module Aws::Finspace
|
|
838
895
|
# resp.last_modified_timestamp #=> Time
|
839
896
|
# resp.savedown_storage_configuration.type #=> String, one of "SDS01"
|
840
897
|
# resp.savedown_storage_configuration.size #=> Integer
|
898
|
+
# resp.savedown_storage_configuration.volume_name #=> String
|
841
899
|
# resp.az_mode #=> String, one of "SINGLE", "MULTI"
|
842
900
|
# resp.availability_zone_id #=> String
|
843
901
|
# resp.created_timestamp #=> Time
|
902
|
+
# resp.scaling_group_configuration.scaling_group_name #=> String
|
903
|
+
# resp.scaling_group_configuration.memory_limit #=> Integer
|
904
|
+
# resp.scaling_group_configuration.memory_reservation #=> Integer
|
905
|
+
# resp.scaling_group_configuration.node_count #=> Integer
|
906
|
+
# resp.scaling_group_configuration.cpu #=> Float
|
844
907
|
#
|
845
908
|
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxCluster AWS API Documentation
|
846
909
|
#
|
@@ -911,6 +974,126 @@ module Aws::Finspace
|
|
911
974
|
req.send_request(options)
|
912
975
|
end
|
913
976
|
|
977
|
+
# Creates a snapshot of kdb database with tiered storage capabilities
|
978
|
+
# and a pre-warmed cache, ready for mounting on kdb clusters. Dataviews
|
979
|
+
# are only available for clusters running on a scaling group. They are
|
980
|
+
# not supported on dedicated clusters.
|
981
|
+
#
|
982
|
+
# @option params [required, String] :environment_id
|
983
|
+
# A unique identifier for the kdb environment, where you want to create
|
984
|
+
# the dataview.
|
985
|
+
#
|
986
|
+
# @option params [required, String] :database_name
|
987
|
+
# The name of the database where you want to create a dataview.
|
988
|
+
#
|
989
|
+
# @option params [required, String] :dataview_name
|
990
|
+
# A unique identifier for the dataview.
|
991
|
+
#
|
992
|
+
# @option params [required, String] :az_mode
|
993
|
+
# The number of availability zones you want to assign per cluster. This
|
994
|
+
# can be one of the following
|
995
|
+
#
|
996
|
+
# * `SINGLE` – Assigns one availability zone per cluster.
|
997
|
+
#
|
998
|
+
# * `MULTI` – Assigns all the availability zones per cluster.
|
999
|
+
#
|
1000
|
+
# @option params [String] :availability_zone_id
|
1001
|
+
# The identifier of the availability zones.
|
1002
|
+
#
|
1003
|
+
# @option params [String] :changeset_id
|
1004
|
+
# A unique identifier of the changeset that you want to use to ingest
|
1005
|
+
# data.
|
1006
|
+
#
|
1007
|
+
# @option params [Array<Types::KxDataviewSegmentConfiguration>] :segment_configurations
|
1008
|
+
# The configuration that contains the database path of the data that you
|
1009
|
+
# want to place on each selected volume. Each segment must have a unique
|
1010
|
+
# database path for each volume. If you do not explicitly specify any
|
1011
|
+
# database path for a volume, they are accessible from the cluster
|
1012
|
+
# through the default S3/object store segment.
|
1013
|
+
#
|
1014
|
+
# @option params [Boolean] :auto_update
|
1015
|
+
# The option to specify whether you want to apply all the future
|
1016
|
+
# additions and corrections automatically to the dataview, when you
|
1017
|
+
# ingest new changesets. The default value is false.
|
1018
|
+
#
|
1019
|
+
# @option params [String] :description
|
1020
|
+
# A description of the dataview.
|
1021
|
+
#
|
1022
|
+
# @option params [Hash<String,String>] :tags
|
1023
|
+
# A list of key-value pairs to label the dataview. You can add up to 50
|
1024
|
+
# tags to a dataview.
|
1025
|
+
#
|
1026
|
+
# @option params [required, String] :client_token
|
1027
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
1028
|
+
#
|
1029
|
+
# **A suitable default value is auto-generated.** You should normally
|
1030
|
+
# not need to pass this option.**
|
1031
|
+
#
|
1032
|
+
# @return [Types::CreateKxDataviewResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1033
|
+
#
|
1034
|
+
# * {Types::CreateKxDataviewResponse#dataview_name #dataview_name} => String
|
1035
|
+
# * {Types::CreateKxDataviewResponse#database_name #database_name} => String
|
1036
|
+
# * {Types::CreateKxDataviewResponse#environment_id #environment_id} => String
|
1037
|
+
# * {Types::CreateKxDataviewResponse#az_mode #az_mode} => String
|
1038
|
+
# * {Types::CreateKxDataviewResponse#availability_zone_id #availability_zone_id} => String
|
1039
|
+
# * {Types::CreateKxDataviewResponse#changeset_id #changeset_id} => String
|
1040
|
+
# * {Types::CreateKxDataviewResponse#segment_configurations #segment_configurations} => Array<Types::KxDataviewSegmentConfiguration>
|
1041
|
+
# * {Types::CreateKxDataviewResponse#description #description} => String
|
1042
|
+
# * {Types::CreateKxDataviewResponse#auto_update #auto_update} => Boolean
|
1043
|
+
# * {Types::CreateKxDataviewResponse#created_timestamp #created_timestamp} => Time
|
1044
|
+
# * {Types::CreateKxDataviewResponse#last_modified_timestamp #last_modified_timestamp} => Time
|
1045
|
+
# * {Types::CreateKxDataviewResponse#status #status} => String
|
1046
|
+
#
|
1047
|
+
# @example Request syntax with placeholder values
|
1048
|
+
#
|
1049
|
+
# resp = client.create_kx_dataview({
|
1050
|
+
# environment_id: "EnvironmentId", # required
|
1051
|
+
# database_name: "DatabaseName", # required
|
1052
|
+
# dataview_name: "KxDataviewName", # required
|
1053
|
+
# az_mode: "SINGLE", # required, accepts SINGLE, MULTI
|
1054
|
+
# availability_zone_id: "AvailabilityZoneId",
|
1055
|
+
# changeset_id: "ChangesetId",
|
1056
|
+
# segment_configurations: [
|
1057
|
+
# {
|
1058
|
+
# db_paths: ["DbPath"], # required
|
1059
|
+
# volume_name: "KxVolumeName", # required
|
1060
|
+
# },
|
1061
|
+
# ],
|
1062
|
+
# auto_update: false,
|
1063
|
+
# description: "Description",
|
1064
|
+
# tags: {
|
1065
|
+
# "TagKey" => "TagValue",
|
1066
|
+
# },
|
1067
|
+
# client_token: "ClientTokenString", # required
|
1068
|
+
# })
|
1069
|
+
#
|
1070
|
+
# @example Response structure
|
1071
|
+
#
|
1072
|
+
# resp.dataview_name #=> String
|
1073
|
+
# resp.database_name #=> String
|
1074
|
+
# resp.environment_id #=> String
|
1075
|
+
# resp.az_mode #=> String, one of "SINGLE", "MULTI"
|
1076
|
+
# resp.availability_zone_id #=> String
|
1077
|
+
# resp.changeset_id #=> String
|
1078
|
+
# resp.segment_configurations #=> Array
|
1079
|
+
# resp.segment_configurations[0].db_paths #=> Array
|
1080
|
+
# resp.segment_configurations[0].db_paths[0] #=> String
|
1081
|
+
# resp.segment_configurations[0].volume_name #=> String
|
1082
|
+
# resp.description #=> String
|
1083
|
+
# resp.auto_update #=> Boolean
|
1084
|
+
# resp.created_timestamp #=> Time
|
1085
|
+
# resp.last_modified_timestamp #=> Time
|
1086
|
+
# resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "FAILED", "DELETING"
|
1087
|
+
#
|
1088
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxDataview AWS API Documentation
|
1089
|
+
#
|
1090
|
+
# @overload create_kx_dataview(params = {})
|
1091
|
+
# @param [Hash] params ({})
|
1092
|
+
def create_kx_dataview(params = {}, options = {})
|
1093
|
+
req = build_request(:create_kx_dataview, params)
|
1094
|
+
req.send_request(options)
|
1095
|
+
end
|
1096
|
+
|
914
1097
|
# Creates a managed kdb environment for the account.
|
915
1098
|
#
|
916
1099
|
# @option params [required, String] :name
|
@@ -929,6 +1112,9 @@ module Aws::Finspace
|
|
929
1112
|
# @option params [String] :client_token
|
930
1113
|
# A token that ensures idempotency. This token expires in 10 minutes.
|
931
1114
|
#
|
1115
|
+
# **A suitable default value is auto-generated.** You should normally
|
1116
|
+
# not need to pass this option.**
|
1117
|
+
#
|
932
1118
|
# @return [Types::CreateKxEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
933
1119
|
#
|
934
1120
|
# * {Types::CreateKxEnvironmentResponse#name #name} => String
|
@@ -970,6 +1156,74 @@ module Aws::Finspace
|
|
970
1156
|
req.send_request(options)
|
971
1157
|
end
|
972
1158
|
|
1159
|
+
# Creates a new scaling group.
|
1160
|
+
#
|
1161
|
+
# @option params [required, String] :client_token
|
1162
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
1163
|
+
#
|
1164
|
+
# **A suitable default value is auto-generated.** You should normally
|
1165
|
+
# not need to pass this option.**
|
1166
|
+
#
|
1167
|
+
# @option params [required, String] :environment_id
|
1168
|
+
# A unique identifier for the kdb environment, where you want to create
|
1169
|
+
# the scaling group.
|
1170
|
+
#
|
1171
|
+
# @option params [required, String] :scaling_group_name
|
1172
|
+
# A unique identifier for the kdb scaling group.
|
1173
|
+
#
|
1174
|
+
# @option params [required, String] :host_type
|
1175
|
+
# The memory and CPU capabilities of the scaling group host on which
|
1176
|
+
# FinSpace Managed kdb clusters will be placed.
|
1177
|
+
#
|
1178
|
+
# @option params [required, String] :availability_zone_id
|
1179
|
+
# The identifier of the availability zones.
|
1180
|
+
#
|
1181
|
+
# @option params [Hash<String,String>] :tags
|
1182
|
+
# A list of key-value pairs to label the scaling group. You can add up
|
1183
|
+
# to 50 tags to a scaling group.
|
1184
|
+
#
|
1185
|
+
# @return [Types::CreateKxScalingGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1186
|
+
#
|
1187
|
+
# * {Types::CreateKxScalingGroupResponse#environment_id #environment_id} => String
|
1188
|
+
# * {Types::CreateKxScalingGroupResponse#scaling_group_name #scaling_group_name} => String
|
1189
|
+
# * {Types::CreateKxScalingGroupResponse#host_type #host_type} => String
|
1190
|
+
# * {Types::CreateKxScalingGroupResponse#availability_zone_id #availability_zone_id} => String
|
1191
|
+
# * {Types::CreateKxScalingGroupResponse#status #status} => String
|
1192
|
+
# * {Types::CreateKxScalingGroupResponse#last_modified_timestamp #last_modified_timestamp} => Time
|
1193
|
+
# * {Types::CreateKxScalingGroupResponse#created_timestamp #created_timestamp} => Time
|
1194
|
+
#
|
1195
|
+
# @example Request syntax with placeholder values
|
1196
|
+
#
|
1197
|
+
# resp = client.create_kx_scaling_group({
|
1198
|
+
# client_token: "ClientToken", # required
|
1199
|
+
# environment_id: "KxEnvironmentId", # required
|
1200
|
+
# scaling_group_name: "KxScalingGroupName", # required
|
1201
|
+
# host_type: "KxHostType", # required
|
1202
|
+
# availability_zone_id: "AvailabilityZoneId", # required
|
1203
|
+
# tags: {
|
1204
|
+
# "TagKey" => "TagValue",
|
1205
|
+
# },
|
1206
|
+
# })
|
1207
|
+
#
|
1208
|
+
# @example Response structure
|
1209
|
+
#
|
1210
|
+
# resp.environment_id #=> String
|
1211
|
+
# resp.scaling_group_name #=> String
|
1212
|
+
# resp.host_type #=> String
|
1213
|
+
# resp.availability_zone_id #=> String
|
1214
|
+
# resp.status #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "DELETING", "DELETED", "DELETE_FAILED"
|
1215
|
+
# resp.last_modified_timestamp #=> Time
|
1216
|
+
# resp.created_timestamp #=> Time
|
1217
|
+
#
|
1218
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxScalingGroup AWS API Documentation
|
1219
|
+
#
|
1220
|
+
# @overload create_kx_scaling_group(params = {})
|
1221
|
+
# @param [Hash] params ({})
|
1222
|
+
def create_kx_scaling_group(params = {}, options = {})
|
1223
|
+
req = build_request(:create_kx_scaling_group, params)
|
1224
|
+
req.send_request(options)
|
1225
|
+
end
|
1226
|
+
|
973
1227
|
# Creates a user in FinSpace kdb environment with an associated IAM
|
974
1228
|
# role.
|
975
1229
|
#
|
@@ -990,6 +1244,9 @@ module Aws::Finspace
|
|
990
1244
|
# @option params [String] :client_token
|
991
1245
|
# A token that ensures idempotency. This token expires in 10 minutes.
|
992
1246
|
#
|
1247
|
+
# **A suitable default value is auto-generated.** You should normally
|
1248
|
+
# not need to pass this option.**
|
1249
|
+
#
|
993
1250
|
# @return [Types::CreateKxUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
994
1251
|
#
|
995
1252
|
# * {Types::CreateKxUserResponse#user_name #user_name} => String
|
@@ -1025,6 +1282,104 @@ module Aws::Finspace
|
|
1025
1282
|
req.send_request(options)
|
1026
1283
|
end
|
1027
1284
|
|
1285
|
+
# Creates a new volume with a specific amount of throughput and storage
|
1286
|
+
# capacity.
|
1287
|
+
#
|
1288
|
+
# @option params [String] :client_token
|
1289
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
1290
|
+
#
|
1291
|
+
# **A suitable default value is auto-generated.** You should normally
|
1292
|
+
# not need to pass this option.**
|
1293
|
+
#
|
1294
|
+
# @option params [required, String] :environment_id
|
1295
|
+
# A unique identifier for the kdb environment, whose clusters can attach
|
1296
|
+
# to the volume.
|
1297
|
+
#
|
1298
|
+
# @option params [required, String] :volume_type
|
1299
|
+
# The type of file system volume. Currently, FinSpace only supports
|
1300
|
+
# `NAS_1` volume type. When you select `NAS_1` volume type, you must
|
1301
|
+
# also provide `nas1Configuration`.
|
1302
|
+
#
|
1303
|
+
# @option params [required, String] :volume_name
|
1304
|
+
# A unique identifier for the volume.
|
1305
|
+
#
|
1306
|
+
# @option params [String] :description
|
1307
|
+
# A description of the volume.
|
1308
|
+
#
|
1309
|
+
# @option params [Types::KxNAS1Configuration] :nas1_configuration
|
1310
|
+
# Specifies the configuration for the Network attached storage (NAS\_1)
|
1311
|
+
# file system volume. This parameter is required when you choose
|
1312
|
+
# `volumeType` as *NAS\_1*.
|
1313
|
+
#
|
1314
|
+
# @option params [required, String] :az_mode
|
1315
|
+
# The number of availability zones you want to assign per cluster.
|
1316
|
+
# Currently, FinSpace only support `SINGLE` for volumes.
|
1317
|
+
#
|
1318
|
+
# @option params [required, Array<String>] :availability_zone_ids
|
1319
|
+
# The identifier of the availability zones.
|
1320
|
+
#
|
1321
|
+
# @option params [Hash<String,String>] :tags
|
1322
|
+
# A list of key-value pairs to label the volume. You can add up to 50
|
1323
|
+
# tags to a volume.
|
1324
|
+
#
|
1325
|
+
# @return [Types::CreateKxVolumeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1326
|
+
#
|
1327
|
+
# * {Types::CreateKxVolumeResponse#environment_id #environment_id} => String
|
1328
|
+
# * {Types::CreateKxVolumeResponse#volume_name #volume_name} => String
|
1329
|
+
# * {Types::CreateKxVolumeResponse#volume_type #volume_type} => String
|
1330
|
+
# * {Types::CreateKxVolumeResponse#volume_arn #volume_arn} => String
|
1331
|
+
# * {Types::CreateKxVolumeResponse#nas1_configuration #nas1_configuration} => Types::KxNAS1Configuration
|
1332
|
+
# * {Types::CreateKxVolumeResponse#status #status} => String
|
1333
|
+
# * {Types::CreateKxVolumeResponse#status_reason #status_reason} => String
|
1334
|
+
# * {Types::CreateKxVolumeResponse#az_mode #az_mode} => String
|
1335
|
+
# * {Types::CreateKxVolumeResponse#description #description} => String
|
1336
|
+
# * {Types::CreateKxVolumeResponse#availability_zone_ids #availability_zone_ids} => Array<String>
|
1337
|
+
# * {Types::CreateKxVolumeResponse#created_timestamp #created_timestamp} => Time
|
1338
|
+
#
|
1339
|
+
# @example Request syntax with placeholder values
|
1340
|
+
#
|
1341
|
+
# resp = client.create_kx_volume({
|
1342
|
+
# client_token: "ClientToken",
|
1343
|
+
# environment_id: "KxEnvironmentId", # required
|
1344
|
+
# volume_type: "NAS_1", # required, accepts NAS_1
|
1345
|
+
# volume_name: "KxVolumeName", # required
|
1346
|
+
# description: "Description",
|
1347
|
+
# nas1_configuration: {
|
1348
|
+
# type: "SSD_1000", # accepts SSD_1000, SSD_250, HDD_12
|
1349
|
+
# size: 1,
|
1350
|
+
# },
|
1351
|
+
# az_mode: "SINGLE", # required, accepts SINGLE, MULTI
|
1352
|
+
# availability_zone_ids: ["AvailabilityZoneId"], # required
|
1353
|
+
# tags: {
|
1354
|
+
# "TagKey" => "TagValue",
|
1355
|
+
# },
|
1356
|
+
# })
|
1357
|
+
#
|
1358
|
+
# @example Response structure
|
1359
|
+
#
|
1360
|
+
# resp.environment_id #=> String
|
1361
|
+
# resp.volume_name #=> String
|
1362
|
+
# resp.volume_type #=> String, one of "NAS_1"
|
1363
|
+
# resp.volume_arn #=> String
|
1364
|
+
# resp.nas1_configuration.type #=> String, one of "SSD_1000", "SSD_250", "HDD_12"
|
1365
|
+
# resp.nas1_configuration.size #=> Integer
|
1366
|
+
# resp.status #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATED", "UPDATE_FAILED", "DELETING", "DELETED", "DELETE_FAILED"
|
1367
|
+
# resp.status_reason #=> String
|
1368
|
+
# resp.az_mode #=> String, one of "SINGLE", "MULTI"
|
1369
|
+
# resp.description #=> String
|
1370
|
+
# resp.availability_zone_ids #=> Array
|
1371
|
+
# resp.availability_zone_ids[0] #=> String
|
1372
|
+
# resp.created_timestamp #=> Time
|
1373
|
+
#
|
1374
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxVolume AWS API Documentation
|
1375
|
+
#
|
1376
|
+
# @overload create_kx_volume(params = {})
|
1377
|
+
# @param [Hash] params ({})
|
1378
|
+
def create_kx_volume(params = {}, options = {})
|
1379
|
+
req = build_request(:create_kx_volume, params)
|
1380
|
+
req.send_request(options)
|
1381
|
+
end
|
1382
|
+
|
1028
1383
|
# Delete an FinSpace environment.
|
1029
1384
|
#
|
1030
1385
|
# @option params [required, String] :environment_id
|
@@ -1115,6 +1470,45 @@ module Aws::Finspace
|
|
1115
1470
|
req.send_request(options)
|
1116
1471
|
end
|
1117
1472
|
|
1473
|
+
# Deletes the specified dataview. Before deleting a dataview, make sure
|
1474
|
+
# that it is not in use by any cluster.
|
1475
|
+
#
|
1476
|
+
# @option params [required, String] :environment_id
|
1477
|
+
# A unique identifier for the kdb environment, from where you want to
|
1478
|
+
# delete the dataview.
|
1479
|
+
#
|
1480
|
+
# @option params [required, String] :database_name
|
1481
|
+
# The name of the database whose dataview you want to delete.
|
1482
|
+
#
|
1483
|
+
# @option params [required, String] :dataview_name
|
1484
|
+
# The name of the dataview that you want to delete.
|
1485
|
+
#
|
1486
|
+
# @option params [required, String] :client_token
|
1487
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
1488
|
+
#
|
1489
|
+
# **A suitable default value is auto-generated.** You should normally
|
1490
|
+
# not need to pass this option.**
|
1491
|
+
#
|
1492
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1493
|
+
#
|
1494
|
+
# @example Request syntax with placeholder values
|
1495
|
+
#
|
1496
|
+
# resp = client.delete_kx_dataview({
|
1497
|
+
# environment_id: "EnvironmentId", # required
|
1498
|
+
# database_name: "DatabaseName", # required
|
1499
|
+
# dataview_name: "KxDataviewName", # required
|
1500
|
+
# client_token: "ClientTokenString", # required
|
1501
|
+
# })
|
1502
|
+
#
|
1503
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxDataview AWS API Documentation
|
1504
|
+
#
|
1505
|
+
# @overload delete_kx_dataview(params = {})
|
1506
|
+
# @param [Hash] params ({})
|
1507
|
+
def delete_kx_dataview(params = {}, options = {})
|
1508
|
+
req = build_request(:delete_kx_dataview, params)
|
1509
|
+
req.send_request(options)
|
1510
|
+
end
|
1511
|
+
|
1118
1512
|
# Deletes the kdb environment. This action is irreversible. Deleting a
|
1119
1513
|
# kdb environment will remove all the associated data and any services
|
1120
1514
|
# running in it.
|
@@ -1122,12 +1516,19 @@ module Aws::Finspace
|
|
1122
1516
|
# @option params [required, String] :environment_id
|
1123
1517
|
# A unique identifier for the kdb environment.
|
1124
1518
|
#
|
1519
|
+
# @option params [String] :client_token
|
1520
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
1521
|
+
#
|
1522
|
+
# **A suitable default value is auto-generated.** You should normally
|
1523
|
+
# not need to pass this option.**
|
1524
|
+
#
|
1125
1525
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1126
1526
|
#
|
1127
1527
|
# @example Request syntax with placeholder values
|
1128
1528
|
#
|
1129
1529
|
# resp = client.delete_kx_environment({
|
1130
1530
|
# environment_id: "IdType", # required
|
1531
|
+
# client_token: "ClientToken",
|
1131
1532
|
# })
|
1132
1533
|
#
|
1133
1534
|
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxEnvironment AWS API Documentation
|
@@ -1139,6 +1540,42 @@ module Aws::Finspace
|
|
1139
1540
|
req.send_request(options)
|
1140
1541
|
end
|
1141
1542
|
|
1543
|
+
# Deletes the specified scaling group. This action is irreversible. You
|
1544
|
+
# cannot delete a scaling group until all the clusters running on it
|
1545
|
+
# have been deleted.
|
1546
|
+
#
|
1547
|
+
# @option params [required, String] :environment_id
|
1548
|
+
# A unique identifier for the kdb environment, from where you want to
|
1549
|
+
# delete the dataview.
|
1550
|
+
#
|
1551
|
+
# @option params [required, String] :scaling_group_name
|
1552
|
+
# A unique identifier for the kdb scaling group.
|
1553
|
+
#
|
1554
|
+
# @option params [String] :client_token
|
1555
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
1556
|
+
#
|
1557
|
+
# **A suitable default value is auto-generated.** You should normally
|
1558
|
+
# not need to pass this option.**
|
1559
|
+
#
|
1560
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1561
|
+
#
|
1562
|
+
# @example Request syntax with placeholder values
|
1563
|
+
#
|
1564
|
+
# resp = client.delete_kx_scaling_group({
|
1565
|
+
# environment_id: "KxEnvironmentId", # required
|
1566
|
+
# scaling_group_name: "KxScalingGroupName", # required
|
1567
|
+
# client_token: "ClientTokenString",
|
1568
|
+
# })
|
1569
|
+
#
|
1570
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxScalingGroup AWS API Documentation
|
1571
|
+
#
|
1572
|
+
# @overload delete_kx_scaling_group(params = {})
|
1573
|
+
# @param [Hash] params ({})
|
1574
|
+
def delete_kx_scaling_group(params = {}, options = {})
|
1575
|
+
req = build_request(:delete_kx_scaling_group, params)
|
1576
|
+
req.send_request(options)
|
1577
|
+
end
|
1578
|
+
|
1142
1579
|
# Deletes a user in the specified kdb environment.
|
1143
1580
|
#
|
1144
1581
|
# @option params [required, String] :user_name
|
@@ -1147,6 +1584,12 @@ module Aws::Finspace
|
|
1147
1584
|
# @option params [required, String] :environment_id
|
1148
1585
|
# A unique identifier for the kdb environment.
|
1149
1586
|
#
|
1587
|
+
# @option params [String] :client_token
|
1588
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
1589
|
+
#
|
1590
|
+
# **A suitable default value is auto-generated.** You should normally
|
1591
|
+
# not need to pass this option.**
|
1592
|
+
#
|
1150
1593
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1151
1594
|
#
|
1152
1595
|
# @example Request syntax with placeholder values
|
@@ -1154,6 +1597,7 @@ module Aws::Finspace
|
|
1154
1597
|
# resp = client.delete_kx_user({
|
1155
1598
|
# user_name: "KxUserNameString", # required
|
1156
1599
|
# environment_id: "IdType", # required
|
1600
|
+
# client_token: "ClientToken",
|
1157
1601
|
# })
|
1158
1602
|
#
|
1159
1603
|
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxUser AWS API Documentation
|
@@ -1165,6 +1609,42 @@ module Aws::Finspace
|
|
1165
1609
|
req.send_request(options)
|
1166
1610
|
end
|
1167
1611
|
|
1612
|
+
# Deletes a volume. You can only delete a volume if it's not attached
|
1613
|
+
# to a cluster or a dataview. When a volume is deleted, any data on the
|
1614
|
+
# volume is lost. This action is irreversible.
|
1615
|
+
#
|
1616
|
+
# @option params [required, String] :environment_id
|
1617
|
+
# A unique identifier for the kdb environment, whose clusters can attach
|
1618
|
+
# to the volume.
|
1619
|
+
#
|
1620
|
+
# @option params [required, String] :volume_name
|
1621
|
+
# The name of the volume that you want to delete.
|
1622
|
+
#
|
1623
|
+
# @option params [String] :client_token
|
1624
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
1625
|
+
#
|
1626
|
+
# **A suitable default value is auto-generated.** You should normally
|
1627
|
+
# not need to pass this option.**
|
1628
|
+
#
|
1629
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1630
|
+
#
|
1631
|
+
# @example Request syntax with placeholder values
|
1632
|
+
#
|
1633
|
+
# resp = client.delete_kx_volume({
|
1634
|
+
# environment_id: "KxEnvironmentId", # required
|
1635
|
+
# volume_name: "KxVolumeName", # required
|
1636
|
+
# client_token: "ClientTokenString",
|
1637
|
+
# })
|
1638
|
+
#
|
1639
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxVolume AWS API Documentation
|
1640
|
+
#
|
1641
|
+
# @overload delete_kx_volume(params = {})
|
1642
|
+
# @param [Hash] params ({})
|
1643
|
+
def delete_kx_volume(params = {}, options = {})
|
1644
|
+
req = build_request(:delete_kx_volume, params)
|
1645
|
+
req.send_request(options)
|
1646
|
+
end
|
1647
|
+
|
1168
1648
|
# Returns the FinSpace environment object.
|
1169
1649
|
#
|
1170
1650
|
# @option params [required, String] :environment_id
|
@@ -1281,6 +1761,8 @@ module Aws::Finspace
|
|
1281
1761
|
# * {Types::GetKxClusterResponse#status_reason #status_reason} => String
|
1282
1762
|
# * {Types::GetKxClusterResponse#cluster_name #cluster_name} => String
|
1283
1763
|
# * {Types::GetKxClusterResponse#cluster_type #cluster_type} => String
|
1764
|
+
# * {Types::GetKxClusterResponse#tickerplant_log_configuration #tickerplant_log_configuration} => Types::TickerplantLogConfiguration
|
1765
|
+
# * {Types::GetKxClusterResponse#volumes #volumes} => Array<Types::Volume>
|
1284
1766
|
# * {Types::GetKxClusterResponse#databases #databases} => Array<Types::KxDatabaseConfiguration>
|
1285
1767
|
# * {Types::GetKxClusterResponse#cache_storage_configurations #cache_storage_configurations} => Array<Types::KxCacheStorageConfiguration>
|
1286
1768
|
# * {Types::GetKxClusterResponse#auto_scaling_configuration #auto_scaling_configuration} => Types::AutoScalingConfiguration
|
@@ -1297,6 +1779,7 @@ module Aws::Finspace
|
|
1297
1779
|
# * {Types::GetKxClusterResponse#az_mode #az_mode} => String
|
1298
1780
|
# * {Types::GetKxClusterResponse#availability_zone_id #availability_zone_id} => String
|
1299
1781
|
# * {Types::GetKxClusterResponse#created_timestamp #created_timestamp} => Time
|
1782
|
+
# * {Types::GetKxClusterResponse#scaling_group_configuration #scaling_group_configuration} => Types::KxScalingGroupConfiguration
|
1300
1783
|
#
|
1301
1784
|
# @example Request syntax with placeholder values
|
1302
1785
|
#
|
@@ -1310,14 +1793,28 @@ module Aws::Finspace
|
|
1310
1793
|
# resp.status #=> String, one of "PENDING", "CREATING", "CREATE_FAILED", "RUNNING", "UPDATING", "DELETING", "DELETED", "DELETE_FAILED"
|
1311
1794
|
# resp.status_reason #=> String
|
1312
1795
|
# resp.cluster_name #=> String
|
1313
|
-
# resp.cluster_type #=> String, one of "HDB", "RDB", "GATEWAY", "GP"
|
1796
|
+
# resp.cluster_type #=> String, one of "HDB", "RDB", "GATEWAY", "GP", "TICKERPLANT"
|
1797
|
+
# resp.tickerplant_log_configuration.tickerplant_log_volumes #=> Array
|
1798
|
+
# resp.tickerplant_log_configuration.tickerplant_log_volumes[0] #=> String
|
1799
|
+
# resp.volumes #=> Array
|
1800
|
+
# resp.volumes[0].volume_name #=> String
|
1801
|
+
# resp.volumes[0].volume_type #=> String, one of "NAS_1"
|
1314
1802
|
# resp.databases #=> Array
|
1315
1803
|
# resp.databases[0].database_name #=> String
|
1316
1804
|
# resp.databases[0].cache_configurations #=> Array
|
1317
1805
|
# resp.databases[0].cache_configurations[0].cache_type #=> String
|
1318
1806
|
# resp.databases[0].cache_configurations[0].db_paths #=> Array
|
1319
1807
|
# resp.databases[0].cache_configurations[0].db_paths[0] #=> String
|
1808
|
+
# resp.databases[0].cache_configurations[0].dataview_name #=> String
|
1320
1809
|
# resp.databases[0].changeset_id #=> String
|
1810
|
+
# resp.databases[0].dataview_name #=> String
|
1811
|
+
# resp.databases[0].dataview_configuration.dataview_name #=> String
|
1812
|
+
# resp.databases[0].dataview_configuration.dataview_version_id #=> String
|
1813
|
+
# resp.databases[0].dataview_configuration.changeset_id #=> String
|
1814
|
+
# resp.databases[0].dataview_configuration.segment_configurations #=> Array
|
1815
|
+
# resp.databases[0].dataview_configuration.segment_configurations[0].db_paths #=> Array
|
1816
|
+
# resp.databases[0].dataview_configuration.segment_configurations[0].db_paths[0] #=> String
|
1817
|
+
# resp.databases[0].dataview_configuration.segment_configurations[0].volume_name #=> String
|
1321
1818
|
# resp.cache_storage_configurations #=> Array
|
1322
1819
|
# resp.cache_storage_configurations[0].type #=> String
|
1323
1820
|
# resp.cache_storage_configurations[0].size #=> Integer
|
@@ -1348,9 +1845,15 @@ module Aws::Finspace
|
|
1348
1845
|
# resp.last_modified_timestamp #=> Time
|
1349
1846
|
# resp.savedown_storage_configuration.type #=> String, one of "SDS01"
|
1350
1847
|
# resp.savedown_storage_configuration.size #=> Integer
|
1848
|
+
# resp.savedown_storage_configuration.volume_name #=> String
|
1351
1849
|
# resp.az_mode #=> String, one of "SINGLE", "MULTI"
|
1352
1850
|
# resp.availability_zone_id #=> String
|
1353
1851
|
# resp.created_timestamp #=> Time
|
1852
|
+
# resp.scaling_group_configuration.scaling_group_name #=> String
|
1853
|
+
# resp.scaling_group_configuration.memory_limit #=> Integer
|
1854
|
+
# resp.scaling_group_configuration.memory_reservation #=> Integer
|
1855
|
+
# resp.scaling_group_configuration.node_count #=> Integer
|
1856
|
+
# resp.scaling_group_configuration.cpu #=> Float
|
1354
1857
|
#
|
1355
1858
|
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxCluster AWS API Documentation
|
1356
1859
|
#
|
@@ -1455,6 +1958,81 @@ module Aws::Finspace
|
|
1455
1958
|
req.send_request(options)
|
1456
1959
|
end
|
1457
1960
|
|
1961
|
+
# Retrieves details of the dataview.
|
1962
|
+
#
|
1963
|
+
# @option params [required, String] :environment_id
|
1964
|
+
# A unique identifier for the kdb environment, from where you want to
|
1965
|
+
# retrieve the dataview details.
|
1966
|
+
#
|
1967
|
+
# @option params [required, String] :database_name
|
1968
|
+
# The name of the database where you created the dataview.
|
1969
|
+
#
|
1970
|
+
# @option params [required, String] :dataview_name
|
1971
|
+
# A unique identifier for the dataview.
|
1972
|
+
#
|
1973
|
+
# @return [Types::GetKxDataviewResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1974
|
+
#
|
1975
|
+
# * {Types::GetKxDataviewResponse#database_name #database_name} => String
|
1976
|
+
# * {Types::GetKxDataviewResponse#dataview_name #dataview_name} => String
|
1977
|
+
# * {Types::GetKxDataviewResponse#az_mode #az_mode} => String
|
1978
|
+
# * {Types::GetKxDataviewResponse#availability_zone_id #availability_zone_id} => String
|
1979
|
+
# * {Types::GetKxDataviewResponse#changeset_id #changeset_id} => String
|
1980
|
+
# * {Types::GetKxDataviewResponse#segment_configurations #segment_configurations} => Array<Types::KxDataviewSegmentConfiguration>
|
1981
|
+
# * {Types::GetKxDataviewResponse#active_versions #active_versions} => Array<Types::KxDataviewActiveVersion>
|
1982
|
+
# * {Types::GetKxDataviewResponse#description #description} => String
|
1983
|
+
# * {Types::GetKxDataviewResponse#auto_update #auto_update} => Boolean
|
1984
|
+
# * {Types::GetKxDataviewResponse#environment_id #environment_id} => String
|
1985
|
+
# * {Types::GetKxDataviewResponse#created_timestamp #created_timestamp} => Time
|
1986
|
+
# * {Types::GetKxDataviewResponse#last_modified_timestamp #last_modified_timestamp} => Time
|
1987
|
+
# * {Types::GetKxDataviewResponse#status #status} => String
|
1988
|
+
# * {Types::GetKxDataviewResponse#status_reason #status_reason} => String
|
1989
|
+
#
|
1990
|
+
# @example Request syntax with placeholder values
|
1991
|
+
#
|
1992
|
+
# resp = client.get_kx_dataview({
|
1993
|
+
# environment_id: "EnvironmentId", # required
|
1994
|
+
# database_name: "DatabaseName", # required
|
1995
|
+
# dataview_name: "KxDataviewName", # required
|
1996
|
+
# })
|
1997
|
+
#
|
1998
|
+
# @example Response structure
|
1999
|
+
#
|
2000
|
+
# resp.database_name #=> String
|
2001
|
+
# resp.dataview_name #=> String
|
2002
|
+
# resp.az_mode #=> String, one of "SINGLE", "MULTI"
|
2003
|
+
# resp.availability_zone_id #=> String
|
2004
|
+
# resp.changeset_id #=> String
|
2005
|
+
# resp.segment_configurations #=> Array
|
2006
|
+
# resp.segment_configurations[0].db_paths #=> Array
|
2007
|
+
# resp.segment_configurations[0].db_paths[0] #=> String
|
2008
|
+
# resp.segment_configurations[0].volume_name #=> String
|
2009
|
+
# resp.active_versions #=> Array
|
2010
|
+
# resp.active_versions[0].changeset_id #=> String
|
2011
|
+
# resp.active_versions[0].segment_configurations #=> Array
|
2012
|
+
# resp.active_versions[0].segment_configurations[0].db_paths #=> Array
|
2013
|
+
# resp.active_versions[0].segment_configurations[0].db_paths[0] #=> String
|
2014
|
+
# resp.active_versions[0].segment_configurations[0].volume_name #=> String
|
2015
|
+
# resp.active_versions[0].attached_clusters #=> Array
|
2016
|
+
# resp.active_versions[0].attached_clusters[0] #=> String
|
2017
|
+
# resp.active_versions[0].created_timestamp #=> Time
|
2018
|
+
# resp.active_versions[0].version_id #=> String
|
2019
|
+
# resp.description #=> String
|
2020
|
+
# resp.auto_update #=> Boolean
|
2021
|
+
# resp.environment_id #=> String
|
2022
|
+
# resp.created_timestamp #=> Time
|
2023
|
+
# resp.last_modified_timestamp #=> Time
|
2024
|
+
# resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "FAILED", "DELETING"
|
2025
|
+
# resp.status_reason #=> String
|
2026
|
+
#
|
2027
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxDataview AWS API Documentation
|
2028
|
+
#
|
2029
|
+
# @overload get_kx_dataview(params = {})
|
2030
|
+
# @param [Hash] params ({})
|
2031
|
+
def get_kx_dataview(params = {}, options = {})
|
2032
|
+
req = build_request(:get_kx_dataview, params)
|
2033
|
+
req.send_request(options)
|
2034
|
+
end
|
2035
|
+
|
1458
2036
|
# Retrieves all the information for the specified kdb environment.
|
1459
2037
|
#
|
1460
2038
|
# @option params [required, String] :environment_id
|
@@ -1528,6 +2106,55 @@ module Aws::Finspace
|
|
1528
2106
|
req.send_request(options)
|
1529
2107
|
end
|
1530
2108
|
|
2109
|
+
# Retrieves details of a scaling group.
|
2110
|
+
#
|
2111
|
+
# @option params [required, String] :environment_id
|
2112
|
+
# A unique identifier for the kdb environment.
|
2113
|
+
#
|
2114
|
+
# @option params [required, String] :scaling_group_name
|
2115
|
+
# A unique identifier for the kdb scaling group.
|
2116
|
+
#
|
2117
|
+
# @return [Types::GetKxScalingGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2118
|
+
#
|
2119
|
+
# * {Types::GetKxScalingGroupResponse#scaling_group_name #scaling_group_name} => String
|
2120
|
+
# * {Types::GetKxScalingGroupResponse#scaling_group_arn #scaling_group_arn} => String
|
2121
|
+
# * {Types::GetKxScalingGroupResponse#host_type #host_type} => String
|
2122
|
+
# * {Types::GetKxScalingGroupResponse#clusters #clusters} => Array<String>
|
2123
|
+
# * {Types::GetKxScalingGroupResponse#availability_zone_id #availability_zone_id} => String
|
2124
|
+
# * {Types::GetKxScalingGroupResponse#status #status} => String
|
2125
|
+
# * {Types::GetKxScalingGroupResponse#status_reason #status_reason} => String
|
2126
|
+
# * {Types::GetKxScalingGroupResponse#last_modified_timestamp #last_modified_timestamp} => Time
|
2127
|
+
# * {Types::GetKxScalingGroupResponse#created_timestamp #created_timestamp} => Time
|
2128
|
+
#
|
2129
|
+
# @example Request syntax with placeholder values
|
2130
|
+
#
|
2131
|
+
# resp = client.get_kx_scaling_group({
|
2132
|
+
# environment_id: "KxEnvironmentId", # required
|
2133
|
+
# scaling_group_name: "KxScalingGroupName", # required
|
2134
|
+
# })
|
2135
|
+
#
|
2136
|
+
# @example Response structure
|
2137
|
+
#
|
2138
|
+
# resp.scaling_group_name #=> String
|
2139
|
+
# resp.scaling_group_arn #=> String
|
2140
|
+
# resp.host_type #=> String
|
2141
|
+
# resp.clusters #=> Array
|
2142
|
+
# resp.clusters[0] #=> String
|
2143
|
+
# resp.availability_zone_id #=> String
|
2144
|
+
# resp.status #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "DELETING", "DELETED", "DELETE_FAILED"
|
2145
|
+
# resp.status_reason #=> String
|
2146
|
+
# resp.last_modified_timestamp #=> Time
|
2147
|
+
# resp.created_timestamp #=> Time
|
2148
|
+
#
|
2149
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxScalingGroup AWS API Documentation
|
2150
|
+
#
|
2151
|
+
# @overload get_kx_scaling_group(params = {})
|
2152
|
+
# @param [Hash] params ({})
|
2153
|
+
def get_kx_scaling_group(params = {}, options = {})
|
2154
|
+
req = build_request(:get_kx_scaling_group, params)
|
2155
|
+
req.send_request(options)
|
2156
|
+
end
|
2157
|
+
|
1531
2158
|
# Retrieves information about the specified kdb user.
|
1532
2159
|
#
|
1533
2160
|
# @option params [required, String] :user_name
|
@@ -1566,6 +2193,68 @@ module Aws::Finspace
|
|
1566
2193
|
req.send_request(options)
|
1567
2194
|
end
|
1568
2195
|
|
2196
|
+
# Retrieves the information about the volume.
|
2197
|
+
#
|
2198
|
+
# @option params [required, String] :environment_id
|
2199
|
+
# A unique identifier for the kdb environment, whose clusters can attach
|
2200
|
+
# to the volume.
|
2201
|
+
#
|
2202
|
+
# @option params [required, String] :volume_name
|
2203
|
+
# A unique identifier for the volume.
|
2204
|
+
#
|
2205
|
+
# @return [Types::GetKxVolumeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2206
|
+
#
|
2207
|
+
# * {Types::GetKxVolumeResponse#environment_id #environment_id} => String
|
2208
|
+
# * {Types::GetKxVolumeResponse#volume_name #volume_name} => String
|
2209
|
+
# * {Types::GetKxVolumeResponse#volume_type #volume_type} => String
|
2210
|
+
# * {Types::GetKxVolumeResponse#volume_arn #volume_arn} => String
|
2211
|
+
# * {Types::GetKxVolumeResponse#nas1_configuration #nas1_configuration} => Types::KxNAS1Configuration
|
2212
|
+
# * {Types::GetKxVolumeResponse#status #status} => String
|
2213
|
+
# * {Types::GetKxVolumeResponse#status_reason #status_reason} => String
|
2214
|
+
# * {Types::GetKxVolumeResponse#created_timestamp #created_timestamp} => Time
|
2215
|
+
# * {Types::GetKxVolumeResponse#description #description} => String
|
2216
|
+
# * {Types::GetKxVolumeResponse#az_mode #az_mode} => String
|
2217
|
+
# * {Types::GetKxVolumeResponse#availability_zone_ids #availability_zone_ids} => Array<String>
|
2218
|
+
# * {Types::GetKxVolumeResponse#last_modified_timestamp #last_modified_timestamp} => Time
|
2219
|
+
# * {Types::GetKxVolumeResponse#attached_clusters #attached_clusters} => Array<Types::KxAttachedCluster>
|
2220
|
+
#
|
2221
|
+
# @example Request syntax with placeholder values
|
2222
|
+
#
|
2223
|
+
# resp = client.get_kx_volume({
|
2224
|
+
# environment_id: "KxEnvironmentId", # required
|
2225
|
+
# volume_name: "KxVolumeName", # required
|
2226
|
+
# })
|
2227
|
+
#
|
2228
|
+
# @example Response structure
|
2229
|
+
#
|
2230
|
+
# resp.environment_id #=> String
|
2231
|
+
# resp.volume_name #=> String
|
2232
|
+
# resp.volume_type #=> String, one of "NAS_1"
|
2233
|
+
# resp.volume_arn #=> String
|
2234
|
+
# resp.nas1_configuration.type #=> String, one of "SSD_1000", "SSD_250", "HDD_12"
|
2235
|
+
# resp.nas1_configuration.size #=> Integer
|
2236
|
+
# resp.status #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATED", "UPDATE_FAILED", "DELETING", "DELETED", "DELETE_FAILED"
|
2237
|
+
# resp.status_reason #=> String
|
2238
|
+
# resp.created_timestamp #=> Time
|
2239
|
+
# resp.description #=> String
|
2240
|
+
# resp.az_mode #=> String, one of "SINGLE", "MULTI"
|
2241
|
+
# resp.availability_zone_ids #=> Array
|
2242
|
+
# resp.availability_zone_ids[0] #=> String
|
2243
|
+
# resp.last_modified_timestamp #=> Time
|
2244
|
+
# resp.attached_clusters #=> Array
|
2245
|
+
# resp.attached_clusters[0].cluster_name #=> String
|
2246
|
+
# resp.attached_clusters[0].cluster_type #=> String, one of "HDB", "RDB", "GATEWAY", "GP", "TICKERPLANT"
|
2247
|
+
# resp.attached_clusters[0].cluster_status #=> String, one of "PENDING", "CREATING", "CREATE_FAILED", "RUNNING", "UPDATING", "DELETING", "DELETED", "DELETE_FAILED"
|
2248
|
+
#
|
2249
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxVolume AWS API Documentation
|
2250
|
+
#
|
2251
|
+
# @overload get_kx_volume(params = {})
|
2252
|
+
# @param [Hash] params ({})
|
2253
|
+
def get_kx_volume(params = {}, options = {})
|
2254
|
+
req = build_request(:get_kx_volume, params)
|
2255
|
+
req.send_request(options)
|
2256
|
+
end
|
2257
|
+
|
1569
2258
|
# A list of all of your FinSpace environments.
|
1570
2259
|
#
|
1571
2260
|
# @option params [String] :next_token
|
@@ -1750,6 +2439,12 @@ module Aws::Finspace
|
|
1750
2439
|
# this cluster type, the node count is fixed at 1. It does not support
|
1751
2440
|
# autoscaling and supports only `SINGLE` AZ mode.
|
1752
2441
|
#
|
2442
|
+
# * Tickerplant – A tickerplant cluster allows you to subscribe to feed
|
2443
|
+
# handlers based on IAM permissions. It can publish to RDBs, other
|
2444
|
+
# Tickerplants, and real-time subscribers (RTS). Tickerplants can
|
2445
|
+
# persist messages to log, which is readable by any RDB environment.
|
2446
|
+
# It supports only single-node that is only one kdb process.
|
2447
|
+
#
|
1753
2448
|
# @option params [Integer] :max_results
|
1754
2449
|
# The maximum number of results to return in this request.
|
1755
2450
|
#
|
@@ -1765,7 +2460,7 @@ module Aws::Finspace
|
|
1765
2460
|
#
|
1766
2461
|
# resp = client.list_kx_clusters({
|
1767
2462
|
# environment_id: "KxEnvironmentId", # required
|
1768
|
-
# cluster_type: "HDB", # accepts HDB, RDB, GATEWAY, GP
|
2463
|
+
# cluster_type: "HDB", # accepts HDB, RDB, GATEWAY, GP, TICKERPLANT
|
1769
2464
|
# max_results: 1,
|
1770
2465
|
# next_token: "PaginationToken",
|
1771
2466
|
# })
|
@@ -1776,9 +2471,12 @@ module Aws::Finspace
|
|
1776
2471
|
# resp.kx_cluster_summaries[0].status #=> String, one of "PENDING", "CREATING", "CREATE_FAILED", "RUNNING", "UPDATING", "DELETING", "DELETED", "DELETE_FAILED"
|
1777
2472
|
# resp.kx_cluster_summaries[0].status_reason #=> String
|
1778
2473
|
# resp.kx_cluster_summaries[0].cluster_name #=> String
|
1779
|
-
# resp.kx_cluster_summaries[0].cluster_type #=> String, one of "HDB", "RDB", "GATEWAY", "GP"
|
2474
|
+
# resp.kx_cluster_summaries[0].cluster_type #=> String, one of "HDB", "RDB", "GATEWAY", "GP", "TICKERPLANT"
|
1780
2475
|
# resp.kx_cluster_summaries[0].cluster_description #=> String
|
1781
2476
|
# resp.kx_cluster_summaries[0].release_label #=> String
|
2477
|
+
# resp.kx_cluster_summaries[0].volumes #=> Array
|
2478
|
+
# resp.kx_cluster_summaries[0].volumes[0].volume_name #=> String
|
2479
|
+
# resp.kx_cluster_summaries[0].volumes[0].volume_type #=> String, one of "NAS_1"
|
1782
2480
|
# resp.kx_cluster_summaries[0].initialization_script #=> String
|
1783
2481
|
# resp.kx_cluster_summaries[0].execution_role #=> String
|
1784
2482
|
# resp.kx_cluster_summaries[0].az_mode #=> String, one of "SINGLE", "MULTI"
|
@@ -1839,6 +2537,77 @@ module Aws::Finspace
|
|
1839
2537
|
req.send_request(options)
|
1840
2538
|
end
|
1841
2539
|
|
2540
|
+
# Returns a list of all the dataviews in the database.
|
2541
|
+
#
|
2542
|
+
# @option params [required, String] :environment_id
|
2543
|
+
# A unique identifier for the kdb environment, for which you want to
|
2544
|
+
# retrieve a list of dataviews.
|
2545
|
+
#
|
2546
|
+
# @option params [required, String] :database_name
|
2547
|
+
# The name of the database where the dataviews were created.
|
2548
|
+
#
|
2549
|
+
# @option params [String] :next_token
|
2550
|
+
# A token that indicates where a results page should begin.
|
2551
|
+
#
|
2552
|
+
# @option params [Integer] :max_results
|
2553
|
+
# The maximum number of results to return in this request.
|
2554
|
+
#
|
2555
|
+
# @return [Types::ListKxDataviewsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2556
|
+
#
|
2557
|
+
# * {Types::ListKxDataviewsResponse#kx_dataviews #kx_dataviews} => Array<Types::KxDataviewListEntry>
|
2558
|
+
# * {Types::ListKxDataviewsResponse#next_token #next_token} => String
|
2559
|
+
#
|
2560
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2561
|
+
#
|
2562
|
+
# @example Request syntax with placeholder values
|
2563
|
+
#
|
2564
|
+
# resp = client.list_kx_dataviews({
|
2565
|
+
# environment_id: "EnvironmentId", # required
|
2566
|
+
# database_name: "DatabaseName", # required
|
2567
|
+
# next_token: "PaginationToken",
|
2568
|
+
# max_results: 1,
|
2569
|
+
# })
|
2570
|
+
#
|
2571
|
+
# @example Response structure
|
2572
|
+
#
|
2573
|
+
# resp.kx_dataviews #=> Array
|
2574
|
+
# resp.kx_dataviews[0].environment_id #=> String
|
2575
|
+
# resp.kx_dataviews[0].database_name #=> String
|
2576
|
+
# resp.kx_dataviews[0].dataview_name #=> String
|
2577
|
+
# resp.kx_dataviews[0].az_mode #=> String, one of "SINGLE", "MULTI"
|
2578
|
+
# resp.kx_dataviews[0].availability_zone_id #=> String
|
2579
|
+
# resp.kx_dataviews[0].changeset_id #=> String
|
2580
|
+
# resp.kx_dataviews[0].segment_configurations #=> Array
|
2581
|
+
# resp.kx_dataviews[0].segment_configurations[0].db_paths #=> Array
|
2582
|
+
# resp.kx_dataviews[0].segment_configurations[0].db_paths[0] #=> String
|
2583
|
+
# resp.kx_dataviews[0].segment_configurations[0].volume_name #=> String
|
2584
|
+
# resp.kx_dataviews[0].active_versions #=> Array
|
2585
|
+
# resp.kx_dataviews[0].active_versions[0].changeset_id #=> String
|
2586
|
+
# resp.kx_dataviews[0].active_versions[0].segment_configurations #=> Array
|
2587
|
+
# resp.kx_dataviews[0].active_versions[0].segment_configurations[0].db_paths #=> Array
|
2588
|
+
# resp.kx_dataviews[0].active_versions[0].segment_configurations[0].db_paths[0] #=> String
|
2589
|
+
# resp.kx_dataviews[0].active_versions[0].segment_configurations[0].volume_name #=> String
|
2590
|
+
# resp.kx_dataviews[0].active_versions[0].attached_clusters #=> Array
|
2591
|
+
# resp.kx_dataviews[0].active_versions[0].attached_clusters[0] #=> String
|
2592
|
+
# resp.kx_dataviews[0].active_versions[0].created_timestamp #=> Time
|
2593
|
+
# resp.kx_dataviews[0].active_versions[0].version_id #=> String
|
2594
|
+
# resp.kx_dataviews[0].status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "FAILED", "DELETING"
|
2595
|
+
# resp.kx_dataviews[0].description #=> String
|
2596
|
+
# resp.kx_dataviews[0].auto_update #=> Boolean
|
2597
|
+
# resp.kx_dataviews[0].created_timestamp #=> Time
|
2598
|
+
# resp.kx_dataviews[0].last_modified_timestamp #=> Time
|
2599
|
+
# resp.kx_dataviews[0].status_reason #=> String
|
2600
|
+
# resp.next_token #=> String
|
2601
|
+
#
|
2602
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxDataviews AWS API Documentation
|
2603
|
+
#
|
2604
|
+
# @overload list_kx_dataviews(params = {})
|
2605
|
+
# @param [Hash] params ({})
|
2606
|
+
def list_kx_dataviews(params = {}, options = {})
|
2607
|
+
req = build_request(:list_kx_dataviews, params)
|
2608
|
+
req.send_request(options)
|
2609
|
+
end
|
2610
|
+
|
1842
2611
|
# Returns a list of kdb environments created in an account.
|
1843
2612
|
#
|
1844
2613
|
# @option params [String] :next_token
|
@@ -1905,6 +2674,56 @@ module Aws::Finspace
|
|
1905
2674
|
req.send_request(options)
|
1906
2675
|
end
|
1907
2676
|
|
2677
|
+
# Returns a list of scaling groups in a kdb environment.
|
2678
|
+
#
|
2679
|
+
# @option params [required, String] :environment_id
|
2680
|
+
# A unique identifier for the kdb environment, for which you want to
|
2681
|
+
# retrieve a list of scaling groups.
|
2682
|
+
#
|
2683
|
+
# @option params [Integer] :max_results
|
2684
|
+
# The maximum number of results to return in this request.
|
2685
|
+
#
|
2686
|
+
# @option params [String] :next_token
|
2687
|
+
# A token that indicates where a results page should begin.
|
2688
|
+
#
|
2689
|
+
# @return [Types::ListKxScalingGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2690
|
+
#
|
2691
|
+
# * {Types::ListKxScalingGroupsResponse#scaling_groups #scaling_groups} => Array<Types::KxScalingGroup>
|
2692
|
+
# * {Types::ListKxScalingGroupsResponse#next_token #next_token} => String
|
2693
|
+
#
|
2694
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2695
|
+
#
|
2696
|
+
# @example Request syntax with placeholder values
|
2697
|
+
#
|
2698
|
+
# resp = client.list_kx_scaling_groups({
|
2699
|
+
# environment_id: "KxEnvironmentId", # required
|
2700
|
+
# max_results: 1,
|
2701
|
+
# next_token: "PaginationToken",
|
2702
|
+
# })
|
2703
|
+
#
|
2704
|
+
# @example Response structure
|
2705
|
+
#
|
2706
|
+
# resp.scaling_groups #=> Array
|
2707
|
+
# resp.scaling_groups[0].scaling_group_name #=> String
|
2708
|
+
# resp.scaling_groups[0].host_type #=> String
|
2709
|
+
# resp.scaling_groups[0].clusters #=> Array
|
2710
|
+
# resp.scaling_groups[0].clusters[0] #=> String
|
2711
|
+
# resp.scaling_groups[0].availability_zone_id #=> String
|
2712
|
+
# resp.scaling_groups[0].status #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "DELETING", "DELETED", "DELETE_FAILED"
|
2713
|
+
# resp.scaling_groups[0].status_reason #=> String
|
2714
|
+
# resp.scaling_groups[0].last_modified_timestamp #=> Time
|
2715
|
+
# resp.scaling_groups[0].created_timestamp #=> Time
|
2716
|
+
# resp.next_token #=> String
|
2717
|
+
#
|
2718
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxScalingGroups AWS API Documentation
|
2719
|
+
#
|
2720
|
+
# @overload list_kx_scaling_groups(params = {})
|
2721
|
+
# @param [Hash] params ({})
|
2722
|
+
def list_kx_scaling_groups(params = {}, options = {})
|
2723
|
+
req = build_request(:list_kx_scaling_groups, params)
|
2724
|
+
req.send_request(options)
|
2725
|
+
end
|
2726
|
+
|
1908
2727
|
# Lists all the users in a kdb environment.
|
1909
2728
|
#
|
1910
2729
|
# @option params [required, String] :environment_id
|
@@ -1948,6 +2767,60 @@ module Aws::Finspace
|
|
1948
2767
|
req.send_request(options)
|
1949
2768
|
end
|
1950
2769
|
|
2770
|
+
# Lists all the volumes in a kdb environment.
|
2771
|
+
#
|
2772
|
+
# @option params [required, String] :environment_id
|
2773
|
+
# A unique identifier for the kdb environment, whose clusters can attach
|
2774
|
+
# to the volume.
|
2775
|
+
#
|
2776
|
+
# @option params [Integer] :max_results
|
2777
|
+
# The maximum number of results to return in this request.
|
2778
|
+
#
|
2779
|
+
# @option params [String] :next_token
|
2780
|
+
# A token that indicates where a results page should begin.
|
2781
|
+
#
|
2782
|
+
# @option params [String] :volume_type
|
2783
|
+
# The type of file system volume. Currently, FinSpace only supports
|
2784
|
+
# `NAS_1` volume type.
|
2785
|
+
#
|
2786
|
+
# @return [Types::ListKxVolumesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2787
|
+
#
|
2788
|
+
# * {Types::ListKxVolumesResponse#kx_volume_summaries #kx_volume_summaries} => Array<Types::KxVolume>
|
2789
|
+
# * {Types::ListKxVolumesResponse#next_token #next_token} => String
|
2790
|
+
#
|
2791
|
+
# @example Request syntax with placeholder values
|
2792
|
+
#
|
2793
|
+
# resp = client.list_kx_volumes({
|
2794
|
+
# environment_id: "KxEnvironmentId", # required
|
2795
|
+
# max_results: 1,
|
2796
|
+
# next_token: "PaginationToken",
|
2797
|
+
# volume_type: "NAS_1", # accepts NAS_1
|
2798
|
+
# })
|
2799
|
+
#
|
2800
|
+
# @example Response structure
|
2801
|
+
#
|
2802
|
+
# resp.kx_volume_summaries #=> Array
|
2803
|
+
# resp.kx_volume_summaries[0].volume_name #=> String
|
2804
|
+
# resp.kx_volume_summaries[0].volume_type #=> String, one of "NAS_1"
|
2805
|
+
# resp.kx_volume_summaries[0].status #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATED", "UPDATE_FAILED", "DELETING", "DELETED", "DELETE_FAILED"
|
2806
|
+
# resp.kx_volume_summaries[0].description #=> String
|
2807
|
+
# resp.kx_volume_summaries[0].status_reason #=> String
|
2808
|
+
# resp.kx_volume_summaries[0].az_mode #=> String, one of "SINGLE", "MULTI"
|
2809
|
+
# resp.kx_volume_summaries[0].availability_zone_ids #=> Array
|
2810
|
+
# resp.kx_volume_summaries[0].availability_zone_ids[0] #=> String
|
2811
|
+
# resp.kx_volume_summaries[0].created_timestamp #=> Time
|
2812
|
+
# resp.kx_volume_summaries[0].last_modified_timestamp #=> Time
|
2813
|
+
# resp.next_token #=> String
|
2814
|
+
#
|
2815
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxVolumes AWS API Documentation
|
2816
|
+
#
|
2817
|
+
# @overload list_kx_volumes(params = {})
|
2818
|
+
# @param [Hash] params ({})
|
2819
|
+
def list_kx_volumes(params = {}, options = {})
|
2820
|
+
req = build_request(:list_kx_volumes, params)
|
2821
|
+
req.send_request(options)
|
2822
|
+
end
|
2823
|
+
|
1951
2824
|
# A list of all tags for a resource.
|
1952
2825
|
#
|
1953
2826
|
# @option params [required, String] :resource_arn
|
@@ -2224,9 +3097,22 @@ module Aws::Finspace
|
|
2224
3097
|
# {
|
2225
3098
|
# cache_type: "KxCacheStorageType", # required
|
2226
3099
|
# db_paths: ["DbPath"], # required
|
3100
|
+
# dataview_name: "KxDataviewName",
|
2227
3101
|
# },
|
2228
3102
|
# ],
|
2229
3103
|
# changeset_id: "ChangesetId",
|
3104
|
+
# dataview_name: "KxDataviewName",
|
3105
|
+
# dataview_configuration: {
|
3106
|
+
# dataview_name: "KxDataviewName",
|
3107
|
+
# dataview_version_id: "VersionId",
|
3108
|
+
# changeset_id: "ChangesetId",
|
3109
|
+
# segment_configurations: [
|
3110
|
+
# {
|
3111
|
+
# db_paths: ["DbPath"], # required
|
3112
|
+
# volume_name: "KxVolumeName", # required
|
3113
|
+
# },
|
3114
|
+
# ],
|
3115
|
+
# },
|
2230
3116
|
# },
|
2231
3117
|
# ],
|
2232
3118
|
# deployment_configuration: {
|
@@ -2292,6 +3178,110 @@ module Aws::Finspace
|
|
2292
3178
|
req.send_request(options)
|
2293
3179
|
end
|
2294
3180
|
|
3181
|
+
# Updates the specified dataview. The dataviews get automatically
|
3182
|
+
# updated when any new changesets are ingested. Each update of the
|
3183
|
+
# dataview creates a new version, including changeset details and cache
|
3184
|
+
# configurations
|
3185
|
+
#
|
3186
|
+
# @option params [required, String] :environment_id
|
3187
|
+
# A unique identifier for the kdb environment, where you want to update
|
3188
|
+
# the dataview.
|
3189
|
+
#
|
3190
|
+
# @option params [required, String] :database_name
|
3191
|
+
# The name of the database.
|
3192
|
+
#
|
3193
|
+
# @option params [required, String] :dataview_name
|
3194
|
+
# The name of the dataview that you want to update.
|
3195
|
+
#
|
3196
|
+
# @option params [String] :description
|
3197
|
+
# The description for a dataview.
|
3198
|
+
#
|
3199
|
+
# @option params [String] :changeset_id
|
3200
|
+
# A unique identifier for the changeset.
|
3201
|
+
#
|
3202
|
+
# @option params [Array<Types::KxDataviewSegmentConfiguration>] :segment_configurations
|
3203
|
+
# The configuration that contains the database path of the data that you
|
3204
|
+
# want to place on each selected volume. Each segment must have a unique
|
3205
|
+
# database path for each volume. If you do not explicitly specify any
|
3206
|
+
# database path for a volume, they are accessible from the cluster
|
3207
|
+
# through the default S3/object store segment.
|
3208
|
+
#
|
3209
|
+
# @option params [required, String] :client_token
|
3210
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
3211
|
+
#
|
3212
|
+
# **A suitable default value is auto-generated.** You should normally
|
3213
|
+
# not need to pass this option.**
|
3214
|
+
#
|
3215
|
+
# @return [Types::UpdateKxDataviewResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3216
|
+
#
|
3217
|
+
# * {Types::UpdateKxDataviewResponse#environment_id #environment_id} => String
|
3218
|
+
# * {Types::UpdateKxDataviewResponse#database_name #database_name} => String
|
3219
|
+
# * {Types::UpdateKxDataviewResponse#dataview_name #dataview_name} => String
|
3220
|
+
# * {Types::UpdateKxDataviewResponse#az_mode #az_mode} => String
|
3221
|
+
# * {Types::UpdateKxDataviewResponse#availability_zone_id #availability_zone_id} => String
|
3222
|
+
# * {Types::UpdateKxDataviewResponse#changeset_id #changeset_id} => String
|
3223
|
+
# * {Types::UpdateKxDataviewResponse#segment_configurations #segment_configurations} => Array<Types::KxDataviewSegmentConfiguration>
|
3224
|
+
# * {Types::UpdateKxDataviewResponse#active_versions #active_versions} => Array<Types::KxDataviewActiveVersion>
|
3225
|
+
# * {Types::UpdateKxDataviewResponse#status #status} => String
|
3226
|
+
# * {Types::UpdateKxDataviewResponse#auto_update #auto_update} => Boolean
|
3227
|
+
# * {Types::UpdateKxDataviewResponse#description #description} => String
|
3228
|
+
# * {Types::UpdateKxDataviewResponse#created_timestamp #created_timestamp} => Time
|
3229
|
+
# * {Types::UpdateKxDataviewResponse#last_modified_timestamp #last_modified_timestamp} => Time
|
3230
|
+
#
|
3231
|
+
# @example Request syntax with placeholder values
|
3232
|
+
#
|
3233
|
+
# resp = client.update_kx_dataview({
|
3234
|
+
# environment_id: "EnvironmentId", # required
|
3235
|
+
# database_name: "DatabaseName", # required
|
3236
|
+
# dataview_name: "KxDataviewName", # required
|
3237
|
+
# description: "Description",
|
3238
|
+
# changeset_id: "ChangesetId",
|
3239
|
+
# segment_configurations: [
|
3240
|
+
# {
|
3241
|
+
# db_paths: ["DbPath"], # required
|
3242
|
+
# volume_name: "KxVolumeName", # required
|
3243
|
+
# },
|
3244
|
+
# ],
|
3245
|
+
# client_token: "ClientTokenString", # required
|
3246
|
+
# })
|
3247
|
+
#
|
3248
|
+
# @example Response structure
|
3249
|
+
#
|
3250
|
+
# resp.environment_id #=> String
|
3251
|
+
# resp.database_name #=> String
|
3252
|
+
# resp.dataview_name #=> String
|
3253
|
+
# resp.az_mode #=> String, one of "SINGLE", "MULTI"
|
3254
|
+
# resp.availability_zone_id #=> String
|
3255
|
+
# resp.changeset_id #=> String
|
3256
|
+
# resp.segment_configurations #=> Array
|
3257
|
+
# resp.segment_configurations[0].db_paths #=> Array
|
3258
|
+
# resp.segment_configurations[0].db_paths[0] #=> String
|
3259
|
+
# resp.segment_configurations[0].volume_name #=> String
|
3260
|
+
# resp.active_versions #=> Array
|
3261
|
+
# resp.active_versions[0].changeset_id #=> String
|
3262
|
+
# resp.active_versions[0].segment_configurations #=> Array
|
3263
|
+
# resp.active_versions[0].segment_configurations[0].db_paths #=> Array
|
3264
|
+
# resp.active_versions[0].segment_configurations[0].db_paths[0] #=> String
|
3265
|
+
# resp.active_versions[0].segment_configurations[0].volume_name #=> String
|
3266
|
+
# resp.active_versions[0].attached_clusters #=> Array
|
3267
|
+
# resp.active_versions[0].attached_clusters[0] #=> String
|
3268
|
+
# resp.active_versions[0].created_timestamp #=> Time
|
3269
|
+
# resp.active_versions[0].version_id #=> String
|
3270
|
+
# resp.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "FAILED", "DELETING"
|
3271
|
+
# resp.auto_update #=> Boolean
|
3272
|
+
# resp.description #=> String
|
3273
|
+
# resp.created_timestamp #=> Time
|
3274
|
+
# resp.last_modified_timestamp #=> Time
|
3275
|
+
#
|
3276
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxDataview AWS API Documentation
|
3277
|
+
#
|
3278
|
+
# @overload update_kx_dataview(params = {})
|
3279
|
+
# @param [Hash] params ({})
|
3280
|
+
def update_kx_dataview(params = {}, options = {})
|
3281
|
+
req = build_request(:update_kx_dataview, params)
|
3282
|
+
req.send_request(options)
|
3283
|
+
end
|
3284
|
+
|
2295
3285
|
# Updates information for the given kdb environment.
|
2296
3286
|
#
|
2297
3287
|
# @option params [required, String] :environment_id
|
@@ -2306,6 +3296,9 @@ module Aws::Finspace
|
|
2306
3296
|
# @option params [String] :client_token
|
2307
3297
|
# A token that ensures idempotency. This token expires in 10 minutes.
|
2308
3298
|
#
|
3299
|
+
# **A suitable default value is auto-generated.** You should normally
|
3300
|
+
# not need to pass this option.**
|
3301
|
+
#
|
2309
3302
|
# @return [Types::UpdateKxEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2310
3303
|
#
|
2311
3304
|
# * {Types::UpdateKxEnvironmentResponse#name #name} => String
|
@@ -2398,6 +3391,9 @@ module Aws::Finspace
|
|
2398
3391
|
# @option params [String] :client_token
|
2399
3392
|
# A token that ensures idempotency. This token expires in 10 minutes.
|
2400
3393
|
#
|
3394
|
+
# **A suitable default value is auto-generated.** You should normally
|
3395
|
+
# not need to pass this option.**
|
3396
|
+
#
|
2401
3397
|
# @return [Types::UpdateKxEnvironmentNetworkResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2402
3398
|
#
|
2403
3399
|
# * {Types::UpdateKxEnvironmentNetworkResponse#name #name} => String
|
@@ -2506,6 +3502,9 @@ module Aws::Finspace
|
|
2506
3502
|
# @option params [String] :client_token
|
2507
3503
|
# A token that ensures idempotency. This token expires in 10 minutes.
|
2508
3504
|
#
|
3505
|
+
# **A suitable default value is auto-generated.** You should normally
|
3506
|
+
# not need to pass this option.**
|
3507
|
+
#
|
2509
3508
|
# @return [Types::UpdateKxUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2510
3509
|
#
|
2511
3510
|
# * {Types::UpdateKxUserResponse#user_name #user_name} => String
|
@@ -2538,6 +3537,89 @@ module Aws::Finspace
|
|
2538
3537
|
req.send_request(options)
|
2539
3538
|
end
|
2540
3539
|
|
3540
|
+
# Updates the throughput or capacity of a volume. During the update
|
3541
|
+
# process, the filesystem might be unavailable for a few minutes. You
|
3542
|
+
# can retry any operations after the update is complete.
|
3543
|
+
#
|
3544
|
+
# @option params [required, String] :environment_id
|
3545
|
+
# A unique identifier for the kdb environment where you created the
|
3546
|
+
# storage volume.
|
3547
|
+
#
|
3548
|
+
# @option params [required, String] :volume_name
|
3549
|
+
# A unique identifier for the volume.
|
3550
|
+
#
|
3551
|
+
# @option params [String] :description
|
3552
|
+
# A description of the volume.
|
3553
|
+
#
|
3554
|
+
# @option params [String] :client_token
|
3555
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
3556
|
+
#
|
3557
|
+
# **A suitable default value is auto-generated.** You should normally
|
3558
|
+
# not need to pass this option.**
|
3559
|
+
#
|
3560
|
+
# @option params [Types::KxNAS1Configuration] :nas1_configuration
|
3561
|
+
# Specifies the configuration for the Network attached storage (NAS\_1)
|
3562
|
+
# file system volume.
|
3563
|
+
#
|
3564
|
+
# @return [Types::UpdateKxVolumeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3565
|
+
#
|
3566
|
+
# * {Types::UpdateKxVolumeResponse#environment_id #environment_id} => String
|
3567
|
+
# * {Types::UpdateKxVolumeResponse#volume_name #volume_name} => String
|
3568
|
+
# * {Types::UpdateKxVolumeResponse#volume_type #volume_type} => String
|
3569
|
+
# * {Types::UpdateKxVolumeResponse#volume_arn #volume_arn} => String
|
3570
|
+
# * {Types::UpdateKxVolumeResponse#nas1_configuration #nas1_configuration} => Types::KxNAS1Configuration
|
3571
|
+
# * {Types::UpdateKxVolumeResponse#status #status} => String
|
3572
|
+
# * {Types::UpdateKxVolumeResponse#description #description} => String
|
3573
|
+
# * {Types::UpdateKxVolumeResponse#status_reason #status_reason} => String
|
3574
|
+
# * {Types::UpdateKxVolumeResponse#created_timestamp #created_timestamp} => Time
|
3575
|
+
# * {Types::UpdateKxVolumeResponse#az_mode #az_mode} => String
|
3576
|
+
# * {Types::UpdateKxVolumeResponse#availability_zone_ids #availability_zone_ids} => Array<String>
|
3577
|
+
# * {Types::UpdateKxVolumeResponse#last_modified_timestamp #last_modified_timestamp} => Time
|
3578
|
+
# * {Types::UpdateKxVolumeResponse#attached_clusters #attached_clusters} => Array<Types::KxAttachedCluster>
|
3579
|
+
#
|
3580
|
+
# @example Request syntax with placeholder values
|
3581
|
+
#
|
3582
|
+
# resp = client.update_kx_volume({
|
3583
|
+
# environment_id: "KxEnvironmentId", # required
|
3584
|
+
# volume_name: "KxVolumeName", # required
|
3585
|
+
# description: "Description",
|
3586
|
+
# client_token: "ClientTokenString",
|
3587
|
+
# nas1_configuration: {
|
3588
|
+
# type: "SSD_1000", # accepts SSD_1000, SSD_250, HDD_12
|
3589
|
+
# size: 1,
|
3590
|
+
# },
|
3591
|
+
# })
|
3592
|
+
#
|
3593
|
+
# @example Response structure
|
3594
|
+
#
|
3595
|
+
# resp.environment_id #=> String
|
3596
|
+
# resp.volume_name #=> String
|
3597
|
+
# resp.volume_type #=> String, one of "NAS_1"
|
3598
|
+
# resp.volume_arn #=> String
|
3599
|
+
# resp.nas1_configuration.type #=> String, one of "SSD_1000", "SSD_250", "HDD_12"
|
3600
|
+
# resp.nas1_configuration.size #=> Integer
|
3601
|
+
# resp.status #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATED", "UPDATE_FAILED", "DELETING", "DELETED", "DELETE_FAILED"
|
3602
|
+
# resp.description #=> String
|
3603
|
+
# resp.status_reason #=> String
|
3604
|
+
# resp.created_timestamp #=> Time
|
3605
|
+
# resp.az_mode #=> String, one of "SINGLE", "MULTI"
|
3606
|
+
# resp.availability_zone_ids #=> Array
|
3607
|
+
# resp.availability_zone_ids[0] #=> String
|
3608
|
+
# resp.last_modified_timestamp #=> Time
|
3609
|
+
# resp.attached_clusters #=> Array
|
3610
|
+
# resp.attached_clusters[0].cluster_name #=> String
|
3611
|
+
# resp.attached_clusters[0].cluster_type #=> String, one of "HDB", "RDB", "GATEWAY", "GP", "TICKERPLANT"
|
3612
|
+
# resp.attached_clusters[0].cluster_status #=> String, one of "PENDING", "CREATING", "CREATE_FAILED", "RUNNING", "UPDATING", "DELETING", "DELETED", "DELETE_FAILED"
|
3613
|
+
#
|
3614
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxVolume AWS API Documentation
|
3615
|
+
#
|
3616
|
+
# @overload update_kx_volume(params = {})
|
3617
|
+
# @param [Hash] params ({})
|
3618
|
+
def update_kx_volume(params = {}, options = {})
|
3619
|
+
req = build_request(:update_kx_volume, params)
|
3620
|
+
req.send_request(options)
|
3621
|
+
end
|
3622
|
+
|
2541
3623
|
# @!endgroup
|
2542
3624
|
|
2543
3625
|
# @param params ({})
|
@@ -2551,7 +3633,7 @@ module Aws::Finspace
|
|
2551
3633
|
params: params,
|
2552
3634
|
config: config)
|
2553
3635
|
context[:gem_name] = 'aws-sdk-finspace'
|
2554
|
-
context[:gem_version] = '1.
|
3636
|
+
context[:gem_version] = '1.27.0'
|
2555
3637
|
Seahorse::Client::Request.new(handlers, context)
|
2556
3638
|
end
|
2557
3639
|
|