Struct aws_sdk_finspace::Client

pub struct Client { /* private fields */ }

Client for FinSpace User Environment Management service

Client for invoking operations on FinSpace User Environment Management service. Each operation on FinSpace User Environment Management service is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_finspace::Client::new(&config);

Occasionally, SDKs may have additional service-specific that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_finspace::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the CreateEnvironment operation has a Client::create_environment, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.create_environment()
    .name("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn create_environment(&self) -> CreateEnvironmentFluentBuilder

Constructs a fluent builder for the CreateEnvironment operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the FinSpace environment to be created.

  • description(impl Into<String>) / set_description(Option<String>):

    The description of the FinSpace environment to be created.

  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):

    The KMS key id to encrypt your data in the FinSpace environment.

  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap<String, String>>):

    Add tags to your FinSpace environment.

  • federation_mode(FederationMode) / set_federation_mode(Option<FederationMode>):

    Authentication mode for the environment.

    • FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.

    • LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.

  • federation_parameters(FederationParameters) / set_federation_parameters(Option<FederationParameters>):

    Configuration information when authentication mode is FEDERATED.

  • superuser_parameters(SuperuserParameters) / set_superuser_parameters(Option<SuperuserParameters>):

    Configuration information for the superuser.

  • data_bundles(impl Into<String>) / set_data_bundles(Option<Vec<String>>):

    The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:

    • arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample Capital Markets datasets, categories and controlled vocabularies.

    • arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and quotes data in addition to sample Capital Markets data.

• On success, responds with CreateEnvironmentOutput with field(s):
  • environment_id(Option<String>):

    The unique identifier for FinSpace environment that you created.

  • environment_arn(Option<String>):

    The Amazon Resource Name (ARN) of the FinSpace environment that you created.

  • environment_url(Option<String>):

    The sign-in URL for the web application of the FinSpace environment you created.

• On failure, responds with SdkError<CreateEnvironmentError>

impl Client

pub fn create_kx_changeset(&self) -> CreateKxChangesetFluentBuilder

Constructs a fluent builder for the CreateKxChangeset operation.

• The fluent builder is configurable:
  • environment_id(impl Into<String>) / set_environment_id(Option<String>):

    A unique identifier of the kdb environment.

  • database_name(impl Into<String>) / set_database_name(Option<String>):

    The name of the kdb database.

  • change_requests(ChangeRequest) / set_change_requests(Option<Vec<ChangeRequest>>):

    A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and a dbPath. A changeType can has the following values:

    • PUT – Adds or updates files in a database.

    • DELETE – Deletes files in a database.

    All the change requests require a mandatory dbPath attribute that defines the path within the database directory. The s3Path attribute defines the s3 source file path and is required for a PUT change type.

    Here is an example of how you can use the change request object:

    [ { “changeType”: “PUT”, “s3Path”:“s3://bucket/db/2020.01.02/”, “dbPath”:“/2020.01.02/”}, { “changeType”: “PUT”, “s3Path”:“s3://bucket/db/sym”, “dbPath”:“/”}, { “changeType”: “DELETE”, “dbPath”: “/2020.01.01/”} ]

    In this example, the first request with PUT change type allows you to add files in the given s3Path under the 2020.01.02 partition of the database. The second request with PUT change type allows you to add a single sym file at database root location. The last request with DELETE change type allows you to delete the files under the 2020.01.01 partition of the database.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    A token that ensures idempotency. This token expires in 10 minutes.

• On success, responds with CreateKxChangesetOutput with field(s):
  • changeset_id(Option<String>):

    A unique identifier for the changeset.

  • database_name(Option<String>):

    The name of the kdb database.

  • environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • change_requests(Option<Vec<ChangeRequest>>):

    A list of change requests.

  • created_timestamp(Option<DateTime>):

    The timestamp at which the changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

  • last_modified_timestamp(Option<DateTime>):

    The timestamp at which the changeset was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

  • status(Option<ChangesetStatus>):

    Status of the changeset creation process.

    • Pending – Changeset creation is pending.

    • Processing – Changeset creation is running.

    • Failed – Changeset creation has failed.

    • Complete – Changeset creation has succeeded.

  • error_info(Option<ErrorInfo>):

    The details of the error that you receive when creating a changeset. It consists of the type of error and the error message.

• On failure, responds with SdkError<CreateKxChangesetError>

impl Client

pub fn create_kx_cluster(&self) -> CreateKxClusterFluentBuilder

Constructs a fluent builder for the CreateKxCluster operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):

    A token that ensures idempotency. This token expires in 10 minutes.

  • environment_id(impl Into<String>) / set_environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):

    A unique name for the cluster that you want to create.

  • cluster_type(KxClusterType) / set_cluster_type(Option<KxClusterType>):

    Specifies the type of KDB database that is being created. The following types are available:

    • HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.

    • RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.

    • GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.

  • databases(KxDatabaseConfiguration) / set_databases(Option<Vec<KxDatabaseConfiguration>>):

    A list of databases that will be available for querying.

  • cache_storage_configurations(KxCacheStorageConfiguration) / set_cache_storage_configurations(Option<Vec<KxCacheStorageConfiguration>>):

    The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.

  • auto_scaling_configuration(AutoScalingConfiguration) / set_auto_scaling_configuration(Option<AutoScalingConfiguration>):

    The configuration based on which FinSpace will scale in or scale out nodes in your cluster.

  • cluster_description(impl Into<String>) / set_cluster_description(Option<String>):

    A description of the cluster.

  • capacity_configuration(CapacityConfiguration) / set_capacity_configuration(Option<CapacityConfiguration>):

    A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.

  • release_label(impl Into<String>) / set_release_label(Option<String>):

    The version of FinSpace managed kdb to run.

  • vpc_configuration(VpcConfiguration) / set_vpc_configuration(Option<VpcConfiguration>):

    Configuration details about the network where the Privatelink endpoint of the cluster resides.

  • initialization_script(impl Into<String>) / set_initialization_script(Option<String>):

    Specifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, somedir/init.q.

  • command_line_arguments(KxCommandLineArgument) / set_command_line_arguments(Option<Vec<KxCommandLineArgument>>):

    Defines the key-value pairs to make them available inside the cluster.

  • code(CodeConfiguration) / set_code(Option<CodeConfiguration>):

    The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.

  • execution_role(impl Into<String>) / set_execution_role(Option<String>):

    An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.

  • savedown_storage_configuration(KxSavedownStorageConfiguration) / set_savedown_storage_configuration(Option<KxSavedownStorageConfiguration>):

    The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType as RDB. All the data written to this storage space is lost when the cluster node is restarted.

  • az_mode(KxAzMode) / set_az_mode(Option<KxAzMode>):

    The number of availability zones you want to assign per cluster. This can be one of the following

    • SINGLE – Assigns one availability zone per cluster.

    • MULTI – Assigns all the availability zones per cluster.

  • availability_zone_id(impl Into<String>) / set_availability_zone_id(Option<String>):

    The availability zone identifiers for the requested regions.

  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap<String, String>>):

    A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster.

• On success, responds with CreateKxClusterOutput with field(s):
  • environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • status(Option<KxClusterStatus>):

    The status of cluster creation.

    • PENDING – The cluster is pending creation.

    • CREATING – The cluster creation process is in progress.

    • CREATE_FAILED – The cluster creation process has failed.

    • RUNNING – The cluster creation process is running.

    • UPDATING – The cluster is in the process of being updated.

    • DELETING – The cluster is in the process of being deleted.

    • DELETED – The cluster has been deleted.

    • DELETE_FAILED – The cluster failed to delete.

  • status_reason(Option<String>):

    The error message when a failed state occurs.

  • cluster_name(Option<String>):

    A unique name for the cluster.

  • cluster_type(Option<KxClusterType>):

    Specifies the type of KDB database that is being created. The following types are available:

    • HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.

    • RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.

    • GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.

  • databases(Option<Vec<KxDatabaseConfiguration>>):

    A list of databases that will be available for querying.

  • cache_storage_configurations(Option<Vec<KxCacheStorageConfiguration>>):

    The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.

  • auto_scaling_configuration(Option<AutoScalingConfiguration>):

    The configuration based on which FinSpace will scale in or scale out nodes in your cluster.

  • cluster_description(Option<String>):

    A description of the cluster.

  • capacity_configuration(Option<CapacityConfiguration>):

    A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.

  • release_label(Option<String>):

    A version of the FinSpace managed kdb to run.

  • vpc_configuration(Option<VpcConfiguration>):

    Configuration details about the network where the Privatelink endpoint of the cluster resides.

  • initialization_script(Option<String>):

    Specifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, somedir/init.q.

  • command_line_arguments(Option<Vec<KxCommandLineArgument>>):

    Defines the key-value pairs to make them available inside the cluster.

  • code(Option<CodeConfiguration>):

    The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.

  • execution_role(Option<String>):

    An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.

  • last_modified_timestamp(Option<DateTime>):

    The last time that the cluster was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

  • savedown_storage_configuration(Option<KxSavedownStorageConfiguration>):

    The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType as RDB. All the data written to this storage space is lost when the cluster node is restarted.

  • az_mode(Option<KxAzMode>):

    The number of availability zones you want to assign per cluster. This can be one of the following

    • SINGLE – Assigns one availability zone per cluster.

    • MULTI – Assigns all the availability zones per cluster.

  • availability_zone_id(Option<String>):

    The availability zone identifiers for the requested regions.

  • created_timestamp(Option<DateTime>):

    The timestamp at which the cluster was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

• On failure, responds with SdkError<CreateKxClusterError>

impl Client

pub fn create_kx_database(&self) -> CreateKxDatabaseFluentBuilder

Constructs a fluent builder for the CreateKxDatabase operation.

• The fluent builder is configurable:
  • environment_id(impl Into<String>) / set_environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • database_name(impl Into<String>) / set_database_name(Option<String>):

    The name of the kdb database.

  • description(impl Into<String>) / set_description(Option<String>):

    A description of the database.

  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap<String, String>>):

    A list of key-value pairs to label the kdb database. You can add up to 50 tags to your kdb database

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    A token that ensures idempotency. This token expires in 10 minutes.

• On success, responds with CreateKxDatabaseOutput with field(s):
  • database_name(Option<String>):

    The name of the kdb database.

  • database_arn(Option<String>):

    The ARN identifier of the database.

  • environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • description(Option<String>):

    A description of the database.

  • created_timestamp(Option<DateTime>):

    The timestamp at which the database is created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

  • last_modified_timestamp(Option<DateTime>):

    The last time that the database was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

• On failure, responds with SdkError<CreateKxDatabaseError>

impl Client

pub fn create_kx_environment(&self) -> CreateKxEnvironmentFluentBuilder

Constructs a fluent builder for the CreateKxEnvironment operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the kdb environment that you want to create.

  • description(impl Into<String>) / set_description(Option<String>):

    A description for the kdb environment.

  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):

    The KMS key ID to encrypt your data in the FinSpace environment.

  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap<String, String>>):

    A list of key-value pairs to label the kdb environment. You can add up to 50 tags to your kdb environment.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    A token that ensures idempotency. This token expires in 10 minutes.

• On success, responds with CreateKxEnvironmentOutput with field(s):
  • name(Option<String>):

    The name of the kdb environment.

  • status(Option<EnvironmentStatus>):

    The status of the kdb environment.

  • environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • description(Option<String>):

    A description for the kdb environment.

  • environment_arn(Option<String>):

    The ARN identifier of the environment.

  • kms_key_id(Option<String>):

    The KMS key ID to encrypt your data in the FinSpace environment.

  • creation_timestamp(Option<DateTime>):

    The timestamp at which the kdb environment was created in FinSpace.

• On failure, responds with SdkError<CreateKxEnvironmentError>

impl Client

pub fn create_kx_user(&self) -> CreateKxUserFluentBuilder

Constructs a fluent builder for the CreateKxUser operation.

• The fluent builder is configurable:
  • environment_id(impl Into<String>) / set_environment_id(Option<String>):

    A unique identifier for the kdb environment where you want to create a user.

  • user_name(impl Into<String>) / set_user_name(Option<String>):

    A unique identifier for the user.

  • iam_role(impl Into<String>) / set_iam_role(Option<String>):

    The IAM role ARN that will be associated with the user.

  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap<String, String>>):

    A list of key-value pairs to label the user. You can add up to 50 tags to a user.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    A token that ensures idempotency. This token expires in 10 minutes.

• On success, responds with CreateKxUserOutput with field(s):
  • user_name(Option<String>):

    A unique identifier for the user.

  • user_arn(Option<String>):

    The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.

  • environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • iam_role(Option<String>):

    The IAM role ARN that will be associated with the user.

• On failure, responds with SdkError<CreateKxUserError>

impl Client

pub fn delete_environment(&self) -> DeleteEnvironmentFluentBuilder

Constructs a fluent builder for the DeleteEnvironment operation.

• The fluent builder is configurable:
  • environment_id(impl Into<String>) / set_environment_id(Option<String>):

    The identifier for the FinSpace environment.

• On success, responds with DeleteEnvironmentOutput
• On failure, responds with SdkError<DeleteEnvironmentError>

impl Client

pub fn delete_kx_cluster(&self) -> DeleteKxClusterFluentBuilder

Constructs a fluent builder for the DeleteKxCluster operation.

• The fluent builder is configurable:
  • environment_id(impl Into<String>) / set_environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):

    The name of the cluster that you want to delete.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    A token that ensures idempotency. This token expires in 10 minutes.

• On success, responds with DeleteKxClusterOutput
• On failure, responds with SdkError<DeleteKxClusterError>

impl Client

pub fn delete_kx_database(&self) -> DeleteKxDatabaseFluentBuilder

Constructs a fluent builder for the DeleteKxDatabase operation.

• The fluent builder is configurable:
  • environment_id(impl Into<String>) / set_environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • database_name(impl Into<String>) / set_database_name(Option<String>):

    The name of the kdb database that you want to delete.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    A token that ensures idempotency. This token expires in 10 minutes.

• On success, responds with DeleteKxDatabaseOutput
• On failure, responds with SdkError<DeleteKxDatabaseError>

impl Client

pub fn delete_kx_environment(&self) -> DeleteKxEnvironmentFluentBuilder

Constructs a fluent builder for the DeleteKxEnvironment operation.

• The fluent builder is configurable:
  • environment_id(impl Into<String>) / set_environment_id(Option<String>):

    A unique identifier for the kdb environment.

• On success, responds with DeleteKxEnvironmentOutput
• On failure, responds with SdkError<DeleteKxEnvironmentError>

impl Client

pub fn delete_kx_user(&self) -> DeleteKxUserFluentBuilder

Constructs a fluent builder for the DeleteKxUser operation.

• The fluent builder is configurable:
  • user_name(impl Into<String>) / set_user_name(Option<String>):

    A unique identifier for the user that you want to delete.

  • environment_id(impl Into<String>) / set_environment_id(Option<String>):

    A unique identifier for the kdb environment.

• On success, responds with DeleteKxUserOutput
• On failure, responds with SdkError<DeleteKxUserError>

impl Client

pub fn get_environment(&self) -> GetEnvironmentFluentBuilder

Constructs a fluent builder for the GetEnvironment operation.

• The fluent builder is configurable:
  • environment_id(impl Into<String>) / set_environment_id(Option<String>):

    The identifier of the FinSpace environment.

• On success, responds with GetEnvironmentOutput with field(s):
  • environment(Option<Environment>):

    The name of the FinSpace environment.

• On failure, responds with SdkError<GetEnvironmentError>

impl Client

pub fn get_kx_changeset(&self) -> GetKxChangesetFluentBuilder

Constructs a fluent builder for the GetKxChangeset operation.

• The fluent builder is configurable:
  • environment_id(impl Into<String>) / set_environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • database_name(impl Into<String>) / set_database_name(Option<String>):

    The name of the kdb database.

  • changeset_id(impl Into<String>) / set_changeset_id(Option<String>):

    A unique identifier of the changeset for which you want to retrieve data.

• On success, responds with GetKxChangesetOutput with field(s):
  • changeset_id(Option<String>):

    A unique identifier for the changeset.

  • database_name(Option<String>):

    The name of the kdb database.

  • environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • change_requests(Option<Vec<ChangeRequest>>):

    A list of change request objects that are run in order.

  • created_timestamp(Option<DateTime>):

    The timestamp at which the changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

  • active_from_timestamp(Option<DateTime>):

    Beginning time from which the changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

  • last_modified_timestamp(Option<DateTime>):

    The timestamp at which the changeset was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

  • status(Option<ChangesetStatus>):

    Status of the changeset creation process.

    • Pending – Changeset creation is pending.

    • Processing – Changeset creation is running.

    • Failed – Changeset creation has failed.

    • Complete – Changeset creation has succeeded.

  • error_info(Option<ErrorInfo>):

    Provides details in the event of a failed flow, including the error type and the related error message.

• On failure, responds with SdkError<GetKxChangesetError>

impl Client

pub fn get_kx_cluster(&self) -> GetKxClusterFluentBuilder

Constructs a fluent builder for the GetKxCluster operation.

• The fluent builder is configurable:
  • environment_id(impl Into<String>) / set_environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):

    The name of the cluster that you want to retrieve.

• On success, responds with GetKxClusterOutput with field(s):
  • status(Option<KxClusterStatus>):

    The status of cluster creation.

    • PENDING – The cluster is pending creation.

    • CREATING – The cluster creation process is in progress.

    • CREATE_FAILED – The cluster creation process has failed.

    • RUNNING – The cluster creation process is running.

    • UPDATING – The cluster is in the process of being updated.

    • DELETING – The cluster is in the process of being deleted.

    • DELETED – The cluster has been deleted.

    • DELETE_FAILED – The cluster failed to delete.

  • status_reason(Option<String>):

    The error message when a failed state occurs.

  • cluster_name(Option<String>):

    A unique name for the cluster.

  • cluster_type(Option<KxClusterType>):

    Specifies the type of KDB database that is being created. The following types are available:

    • HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.

    • RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.

    • GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.

  • databases(Option<Vec<KxDatabaseConfiguration>>):

    A list of databases mounted on the cluster.

  • cache_storage_configurations(Option<Vec<KxCacheStorageConfiguration>>):

    The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.

  • auto_scaling_configuration(Option<AutoScalingConfiguration>):

    The configuration based on which FinSpace will scale in or scale out nodes in your cluster.

  • cluster_description(Option<String>):

    A description of the cluster.

  • capacity_configuration(Option<CapacityConfiguration>):

    A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.

  • release_label(Option<String>):

    The version of FinSpace managed kdb to run.

  • vpc_configuration(Option<VpcConfiguration>):

    Configuration details about the network where the Privatelink endpoint of the cluster resides.

  • initialization_script(Option<String>):

    Specifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, somedir/init.q.

  • command_line_arguments(Option<Vec<KxCommandLineArgument>>):

    Defines key-value pairs to make them available inside the cluster.

  • code(Option<CodeConfiguration>):

    The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.

  • execution_role(Option<String>):

    An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.

  • last_modified_timestamp(Option<DateTime>):

    The last time that the cluster was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

  • savedown_storage_configuration(Option<KxSavedownStorageConfiguration>):

    The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType as RDB. All the data written to this storage space is lost when the cluster node is restarted.

  • az_mode(Option<KxAzMode>):

    The number of availability zones you want to assign per cluster. This can be one of the following

    • SINGLE – Assigns one availability zone per cluster.

    • MULTI – Assigns all the availability zones per cluster.

  • availability_zone_id(Option<String>):

    The availability zone identifiers for the requested regions.

  • created_timestamp(Option<DateTime>):

    The timestamp at which the cluster was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

• On failure, responds with SdkError<GetKxClusterError>

impl Client

pub fn get_kx_connection_string(&self) -> GetKxConnectionStringFluentBuilder

Constructs a fluent builder for the GetKxConnectionString operation.

• The fluent builder is configurable:
  • user_arn(impl Into<String>) / set_user_arn(Option<String>):

    The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.

  • environment_id(impl Into<String>) / set_environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):

    A name of the kdb cluster.

• On success, responds with GetKxConnectionStringOutput with field(s):
  • signed_connection_string(Option<String>):

    The signed connection string that you can use to connect to clusters.

• On failure, responds with SdkError<GetKxConnectionStringError>

impl Client

pub fn get_kx_database(&self) -> GetKxDatabaseFluentBuilder

Constructs a fluent builder for the GetKxDatabase operation.

• The fluent builder is configurable:
  • environment_id(impl Into<String>) / set_environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • database_name(impl Into<String>) / set_database_name(Option<String>):

    The name of the kdb database.

• On success, responds with GetKxDatabaseOutput with field(s):
  • database_name(Option<String>):

    The name of the kdb database for which the information is retrieved.

  • database_arn(Option<String>):

    The ARN identifier of the database.

  • environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • description(Option<String>):

    A description of the database.

  • created_timestamp(Option<DateTime>):

    The timestamp at which the database is created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

  • last_modified_timestamp(Option<DateTime>):

    The last time that the database was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

  • last_completed_changeset_id(Option<String>):

    A unique identifier for the changeset.

  • num_bytes(i64):

    The total number of bytes in the database.

  • num_changesets(i32):

    The total number of changesets in the database.

  • num_files(i32):

    The total number of files in the database.

• On failure, responds with SdkError<GetKxDatabaseError>

impl Client

pub fn get_kx_environment(&self) -> GetKxEnvironmentFluentBuilder

Constructs a fluent builder for the GetKxEnvironment operation.

• The fluent builder is configurable:
  • environment_id(impl Into<String>) / set_environment_id(Option<String>):

    A unique identifier for the kdb environment.

• On success, responds with GetKxEnvironmentOutput with field(s):
  • name(Option<String>):

    The name of the kdb environment.

  • environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • aws_account_id(Option<String>):

    The unique identifier of the AWS account that is used to create the kdb environment.

  • status(Option<EnvironmentStatus>):

    The status of the kdb environment.

  • tgw_status(Option<TgwStatus>):

    The status of the network configuration.

  • dns_status(Option<DnsStatus>):

    The status of DNS configuration.

  • error_message(Option<String>):

    Specifies the error message that appears if a flow fails.

  • description(Option<String>):

    A description for the kdb environment.

  • environment_arn(Option<String>):

    The ARN identifier of the environment.

  • kms_key_id(Option<String>):

    The KMS key ID to encrypt your data in the FinSpace environment.

  • dedicated_service_account_id(Option<String>):

    A unique identifier for the AWS environment infrastructure account.

  • transit_gateway_configuration(Option<TransitGatewayConfiguration>):

    The structure of the transit gateway and network configuration that is used to connect the kdb environment to an internal network.

  • custom_dns_configuration(Option<Vec<CustomDnsServer>>):

    A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.

  • creation_timestamp(Option<DateTime>):

    The timestamp at which the kdb environment was created in FinSpace.

  • update_timestamp(Option<DateTime>):

    The timestamp at which the kdb environment was updated.

  • availability_zone_ids(Option<Vec<String>>):

    The identifier of the availability zones where subnets for the environment are created.

  • certificate_authority_arn(Option<String>):

    The Amazon Resource Name (ARN) of the certificate authority of the kdb environment.

• On failure, responds with SdkError<GetKxEnvironmentError>

impl Client

pub fn get_kx_user(&self) -> GetKxUserFluentBuilder

Constructs a fluent builder for the GetKxUser operation.

• The fluent builder is configurable:
  • user_name(impl Into<String>) / set_user_name(Option<String>):

    A unique identifier for the user.

  • environment_id(impl Into<String>) / set_environment_id(Option<String>):

    A unique identifier for the kdb environment.

• On success, responds with GetKxUserOutput with field(s):
  • user_name(Option<String>):

    A unique identifier for the user.

  • user_arn(Option<String>):

    The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.

  • environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • iam_role(Option<String>):

    The IAM role ARN that is associated with the user.

• On failure, responds with SdkError<GetKxUserError>

impl Client

pub fn list_environments(&self) -> ListEnvironmentsFluentBuilder

Constructs a fluent builder for the ListEnvironments operation.

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):

    A token generated by FinSpace that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the nextTokennextToken value from the response object of the previous page call.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of results to return in this request.

• On success, responds with ListEnvironmentsOutput with field(s):
  • environments(Option<Vec<Environment>>):

    A list of all of your FinSpace environments.

  • next_token(Option<String>):

    A token that you can use in a subsequent call to retrieve the next set of results.

• On failure, responds with SdkError<ListEnvironmentsError>

impl Client

pub fn list_kx_changesets(&self) -> ListKxChangesetsFluentBuilder

Constructs a fluent builder for the ListKxChangesets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • environment_id(impl Into<String>) / set_environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • database_name(impl Into<String>) / set_database_name(Option<String>):

    The name of the kdb database.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    A token that indicates where a results page should begin.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of results to return in this request.

• On success, responds with ListKxChangesetsOutput with field(s):
  • kx_changesets(Option<Vec<KxChangesetListEntry>>):

    A list of changesets for a database.

  • next_token(Option<String>):

    A token that indicates where a results page should begin.

• On failure, responds with SdkError<ListKxChangesetsError>

impl Client

pub fn list_kx_cluster_nodes(&self) -> ListKxClusterNodesFluentBuilder

Constructs a fluent builder for the ListKxClusterNodes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • environment_id(impl Into<String>) / set_environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):

    A unique name for the cluster.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    A token that indicates where a results page should begin.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of results to return in this request.

• On success, responds with ListKxClusterNodesOutput with field(s):
  • nodes(Option<Vec<KxNode>>):

    A list of nodes associated with the cluster.

  • next_token(Option<String>):

    A token that indicates where a results page should begin.

• On failure, responds with SdkError<ListKxClusterNodesError>

impl Client

pub fn list_kx_clusters(&self) -> ListKxClustersFluentBuilder

Constructs a fluent builder for the ListKxClusters operation.

• The fluent builder is configurable:
  • environment_id(impl Into<String>) / set_environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • cluster_type(KxClusterType) / set_cluster_type(Option<KxClusterType>):

    Specifies the type of KDB database that is being created. The following types are available:

    • HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.

    • RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.

    • GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of results to return in this request.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    A token that indicates where a results page should begin.

• On success, responds with ListKxClustersOutput with field(s):
  • kx_cluster_summaries(Option<Vec<KxCluster>>):

    Lists the cluster details.

  • next_token(Option<String>):

    A token that indicates where a results page should begin.

• On failure, responds with SdkError<ListKxClustersError>

impl Client

pub fn list_kx_databases(&self) -> ListKxDatabasesFluentBuilder

Constructs a fluent builder for the ListKxDatabases operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • environment_id(impl Into<String>) / set_environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    A token that indicates where a results page should begin.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of results to return in this request.

• On success, responds with ListKxDatabasesOutput with field(s):
  • kx_databases(Option<Vec<KxDatabaseListEntry>>):

    A list of databases in the kdb environment.

  • next_token(Option<String>):

    A token that indicates where a results page should begin.

• On failure, responds with SdkError<ListKxDatabasesError>

impl Client

pub fn list_kx_environments(&self) -> ListKxEnvironmentsFluentBuilder

Constructs a fluent builder for the ListKxEnvironments operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):

    A token that indicates where a results page should begin.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of results to return in this request.

• On success, responds with ListKxEnvironmentsOutput with field(s):
  • environments(Option<Vec<KxEnvironment>>):

    A list of environments in an account.

  • next_token(Option<String>):

    A token that indicates where a results page should begin.

• On failure, responds with SdkError<ListKxEnvironmentsError>

impl Client

pub fn list_kx_users(&self) -> ListKxUsersFluentBuilder

Constructs a fluent builder for the ListKxUsers operation.

• The fluent builder is configurable:
  • environment_id(impl Into<String>) / set_environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    A token that indicates where a results page should begin.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of results to return in this request.

• On success, responds with ListKxUsersOutput with field(s):
  • users(Option<Vec<KxUser>>):

    A list of users in a kdb environment.

  • next_token(Option<String>):

    A token that indicates where a results page should begin.

• On failure, responds with SdkError<ListKxUsersError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The Amazon Resource Name of the resource.

• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap<String, String>>):

    A list of all tags for a resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The Amazon Resource Name (ARN) for the resource.

  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap<String, String>>):

    One or more tags to be assigned to the resource.

• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    A FinSpace resource from which you want to remove a tag or tags. The value for this parameter is an Amazon Resource Name (ARN).

  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec<String>>):

    The tag keys (names) of one or more tags to be removed.

• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_environment(&self) -> UpdateEnvironmentFluentBuilder

Constructs a fluent builder for the UpdateEnvironment operation.

• The fluent builder is configurable:
  • environment_id(impl Into<String>) / set_environment_id(Option<String>):

    The identifier of the FinSpace environment.

  • name(impl Into<String>) / set_name(Option<String>):

    The name of the environment.

  • description(impl Into<String>) / set_description(Option<String>):

    The description of the environment.

  • federation_mode(FederationMode) / set_federation_mode(Option<FederationMode>):

    Authentication mode for the environment.

    • FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.

    • LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.

  • federation_parameters(FederationParameters) / set_federation_parameters(Option<FederationParameters>):

    Configuration information when authentication mode is FEDERATED.

• On success, responds with UpdateEnvironmentOutput with field(s):
  • environment(Option<Environment>):

    Returns the FinSpace environment object.

• On failure, responds with SdkError<UpdateEnvironmentError>

impl Client

pub fn update_kx_cluster_databases( &self ) -> UpdateKxClusterDatabasesFluentBuilder

Constructs a fluent builder for the UpdateKxClusterDatabases operation.

• The fluent builder is configurable:
  • environment_id(impl Into<String>) / set_environment_id(Option<String>):

    The unique identifier of a kdb environment.

  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):

    A unique name for the cluster that you want to modify.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    A token that ensures idempotency. This token expires in 10 minutes.

  • databases(KxDatabaseConfiguration) / set_databases(Option<Vec<KxDatabaseConfiguration>>):

    The structure of databases mounted on the cluster.

  • deployment_configuration(KxDeploymentConfiguration) / set_deployment_configuration(Option<KxDeploymentConfiguration>):

    The configuration that allows you to choose how you want to update the databases on a cluster.

• On success, responds with UpdateKxClusterDatabasesOutput
• On failure, responds with SdkError<UpdateKxClusterDatabasesError>

impl Client

pub fn update_kx_database(&self) -> UpdateKxDatabaseFluentBuilder

Constructs a fluent builder for the UpdateKxDatabase operation.

• The fluent builder is configurable:
  • environment_id(impl Into<String>) / set_environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • database_name(impl Into<String>) / set_database_name(Option<String>):

    The name of the kdb database.

  • description(impl Into<String>) / set_description(Option<String>):

    A description of the database.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    A token that ensures idempotency. This token expires in 10 minutes.

• On success, responds with UpdateKxDatabaseOutput with field(s):
  • database_name(Option<String>):

    The name of the kdb database.

  • environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • description(Option<String>):

    A description of the database.

  • last_modified_timestamp(Option<DateTime>):

    The last time that the database was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

• On failure, responds with SdkError<UpdateKxDatabaseError>

impl Client

pub fn update_kx_environment(&self) -> UpdateKxEnvironmentFluentBuilder

Constructs a fluent builder for the UpdateKxEnvironment operation.

• The fluent builder is configurable:
  • environment_id(impl Into<String>) / set_environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • name(impl Into<String>) / set_name(Option<String>):

    The name of the kdb environment.

  • description(impl Into<String>) / set_description(Option<String>):

    A description of the kdb environment.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    A token that ensures idempotency. This token expires in 10 minutes.

• On success, responds with UpdateKxEnvironmentOutput with field(s):
  • name(Option<String>):

    The name of the kdb environment.

  • environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • aws_account_id(Option<String>):

    The unique identifier of the AWS account that is used to create the kdb environment.

  • status(Option<EnvironmentStatus>):

    The status of the kdb environment.

  • tgw_status(Option<TgwStatus>):

    The status of the network configuration.

  • dns_status(Option<DnsStatus>):

    The status of DNS configuration.

  • error_message(Option<String>):

    Specifies the error message that appears if a flow fails.

  • description(Option<String>):

    The description of the environment.

  • environment_arn(Option<String>):

    The ARN identifier of the environment.

  • kms_key_id(Option<String>):

    The KMS key ID to encrypt your data in the FinSpace environment.

  • dedicated_service_account_id(Option<String>):

    A unique identifier for the AWS environment infrastructure account.

  • transit_gateway_configuration(Option<TransitGatewayConfiguration>):

    The structure of the transit gateway and network configuration that is used to connect the kdb environment to an internal network.

  • custom_dns_configuration(Option<Vec<CustomDnsServer>>):

    A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.

  • creation_timestamp(Option<DateTime>):

    The timestamp at which the kdb environment was created in FinSpace.

  • update_timestamp(Option<DateTime>):

    The timestamp at which the kdb environment was updated.

  • availability_zone_ids(Option<Vec<String>>):

    The identifier of the availability zones where subnets for the environment are created.

• On failure, responds with SdkError<UpdateKxEnvironmentError>

impl Client

pub fn update_kx_environment_network( &self ) -> UpdateKxEnvironmentNetworkFluentBuilder

Constructs a fluent builder for the UpdateKxEnvironmentNetwork operation.

• The fluent builder is configurable:
  • environment_id(impl Into<String>) / set_environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • transit_gateway_configuration(TransitGatewayConfiguration) / set_transit_gateway_configuration(Option<TransitGatewayConfiguration>):

    Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.

  • custom_dns_configuration(CustomDnsServer) / set_custom_dns_configuration(Option<Vec<CustomDnsServer>>):

    A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    A token that ensures idempotency. This token expires in 10 minutes.

• On success, responds with UpdateKxEnvironmentNetworkOutput with field(s):
  • name(Option<String>):

    The name of the kdb environment.

  • environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • aws_account_id(Option<String>):

    The unique identifier of the AWS account that is used to create the kdb environment.

  • status(Option<EnvironmentStatus>):

    The status of the kdb environment.

  • tgw_status(Option<TgwStatus>):

    The status of the network configuration.

  • dns_status(Option<DnsStatus>):

    The status of DNS configuration.

  • error_message(Option<String>):

    Specifies the error message that appears if a flow fails.

  • description(Option<String>):

    The description of the environment.

  • environment_arn(Option<String>):

    The ARN identifier of the environment.

  • kms_key_id(Option<String>):

    The KMS key ID to encrypt your data in the FinSpace environment.

  • dedicated_service_account_id(Option<String>):

    A unique identifier for the AWS environment infrastructure account.

  • transit_gateway_configuration(Option<TransitGatewayConfiguration>):

    The structure of the transit gateway and network configuration that is used to connect the kdb environment to an internal network.

  • custom_dns_configuration(Option<Vec<CustomDnsServer>>):

    A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.

  • creation_timestamp(Option<DateTime>):

    The timestamp at which the kdb environment was created in FinSpace.

  • update_timestamp(Option<DateTime>):

    The timestamp at which the kdb environment was updated.

  • availability_zone_ids(Option<Vec<String>>):

    The identifier of the availability zones where subnets for the environment are created.

• On failure, responds with SdkError<UpdateKxEnvironmentNetworkError>

impl Client

pub fn update_kx_user(&self) -> UpdateKxUserFluentBuilder

Constructs a fluent builder for the UpdateKxUser operation.

• The fluent builder is configurable:
  • environment_id(impl Into<String>) / set_environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • user_name(impl Into<String>) / set_user_name(Option<String>):

    A unique identifier for the user.

  • iam_role(impl Into<String>) / set_iam_role(Option<String>):

    The IAM role ARN that is associated with the user.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    A token that ensures idempotency. This token expires in 10 minutes.

• On success, responds with UpdateKxUserOutput with field(s):
  • user_name(Option<String>):

    A unique identifier for the user.

  • user_arn(Option<String>):

    The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.

  • environment_id(Option<String>):

    A unique identifier for the kdb environment.

  • iam_role(Option<String>):

    The IAM role ARN that is associated with the user.

• On failure, responds with SdkError<UpdateKxUserError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic if the conf has retry or timeouts enabled without a sleep_impl. If you experience this panic, it can be fixed by setting the sleep_impl, or by disabling retries and timeouts.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.