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.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_finspace::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::retry::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_finspace::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_finspace::Client::from_conf(config);

Implementations

impl Client

pub fn with_config(
    client: Client<DynConnector, DynMiddleware<DynConnector>>,
    conf: Config
) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn create_environment(&self) -> CreateEnvironment

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(HashMap<String, 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(Vec<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>

pub fn delete_environment(&self) -> DeleteEnvironment

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>

pub fn get_environment(&self) -> GetEnvironment

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>

pub fn list_environments(&self) -> ListEnvironments

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 nextToken value from the response object of the previous page call.

  • max_results(i32) / set_max_results(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>

pub fn list_tags_for_resource(&self) -> ListTagsForResource

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>

pub fn tag_resource(&self) -> TagResource

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(HashMap<String, 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>

pub fn untag_resource(&self) -> UntagResource

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(Vec<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>

pub fn update_environment(&self) -> UpdateEnvironment

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 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.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

• This method will panic if the conf 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 conf 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) -> Self

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.

impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Converts to this type from the input type.