POST

/environment

http://finspace.{region}.amazonaws.com/environment

Create a new FinSpace environment.

Access Token Required: API Key

Body Params

namestringrequired

The name of the FinSpace environment to be created.

tagsobject

Add tags to your FinSpace environment.

kmsKeyIdstring

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

dataBundlesarray

The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs: <ul> <li> <code>arn:aws:finspace:${Region}::data-bundle/capital-markets-sample</code> - Contains sample Capital Markets datasets, categories and controlled vocabularies. </li> <li> <code>arn:aws:finspace:${Region}::data-bundle/taq</code> (default) - Contains trades and quotes data in addition to sample Capital Markets data. </li> </ul>

descriptionstring

The description of the FinSpace environment to be created.

federationModestring

Authentication mode for the environment. <ul> <li> <code>FEDERATED</code> - Users access FinSpace through Single Sign On (SSO) via your Identity provider. </li> <li> <code>LOCAL</code> - Users access FinSpace via email and password managed within the FinSpace environment. </li> </ul>

superuserParametersobject

Configuration information for the superuser.

federationParametersobject

Configuration information when authentication mode is FEDERATED.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://finspace.{region}.amazonaws.com/environment' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}