Edit on GitHub

Finspace

This page documents function available when using the Finspace module, created with @service Finspace.

Index

Documentation

Main.Finspace.create_environment — Method
create_environment(name)
create_environment(name, params::Dict{String,<:Any})

Create a new FinSpace environment.

Arguments

  • name: The name of the FinSpace environment to be created.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The description of the FinSpace environment to be created.
  • "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.
  • "federationParameters": Configuration information when authentication mode is FEDERATED.
  • "kmsKeyId": The KMS key id to encrypt your data in the FinSpace environment.
  • "tags": Add tags to your FinSpace environment.
source
Main.Finspace.delete_environment — Method
delete_environment(environment_id)
delete_environment(environment_id, params::Dict{String,<:Any})

Delete an FinSpace environment.

Arguments

  • environment_id: The identifier for the FinSpace environment.
source
Main.Finspace.get_environment — Method
get_environment(environment_id)
get_environment(environment_id, params::Dict{String,<:Any})

Returns the FinSpace environment object.

Arguments

  • environment_id: The identifier of the FinSpace environment.
source
Main.Finspace.list_environments — Method
list_environments()
list_environments(params::Dict{String,<:Any})

A list of all of your FinSpace environments.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return in this request.
  • "nextToken": 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.
source
Main.Finspace.list_tags_for_resource — Method
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

A list of all tags for a resource.

Arguments

  • resource_arn: The Amazon Resource Name of the resource.
source
Main.Finspace.tag_resource — Method
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Adds metadata tags to a FinSpace resource.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) for the resource.
  • tags: One or more tags to be assigned to the resource.
source
Main.Finspace.untag_resource — Method
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes metadata tags from a FinSpace resource.

Arguments

  • resource_arn: 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: The tag keys (names) of one or more tags to be removed.
source
Main.Finspace.update_environment — Method
update_environment(environment_id)
update_environment(environment_id, params::Dict{String,<:Any})

Update your FinSpace environment.

Arguments

  • environment_id: The identifier of the FinSpace environment.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The description of the environment.
  • "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.
  • "federationParameters":
  • "name": The name of the environment.
source