Amazon FinSpace Dataset Browser will be discontinued on November 29,
2024. Starting November 29, 2023, FinSpace will no longer accept the creation of new Dataset Browser
environments. Customers using Amazon FinSpace with Managed Kdb Insights
CreateEnvironment
Create a new FinSpace environment.
Request Syntax
POST /environment HTTP/1.1
Content-type: application/json
{
"dataBundles": [ "string" ],
"description": "string",
"federationMode": "string",
"federationParameters": {
"applicationCallBackURL": "string",
"attributeMap": {
"string" : "string"
},
"federationProviderName": "string",
"federationURN": "string",
"samlMetadataDocument": "string",
"samlMetadataURL": "string"
},
"kmsKeyId": "string",
"name": "string",
"superuserParameters": {
"emailAddress": "string",
"firstName": "string",
"lastName": "string"
},
"tags": {
"string" : "string"
}
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- name
-
The name of the FinSpace environment to be created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$Required: Yes
- dataBundles
-
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.
Type: Array of strings
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\d*:data-bundle/[0-9A-Za-z_-]{1,128}$Required: No
-
- description
-
The description of the FinSpace environment to be created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern:
^[a-zA-Z0-9. ]{1,1000}$Required: No
- 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.
Type: String
Valid Values:
FEDERATED | LOCALRequired: No
-
- federationParameters
-
Configuration information when authentication mode is FEDERATED.
Type: FederationParameters object
Required: No
- kmsKeyId
-
The KMS key id to encrypt your data in the FinSpace environment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern:
^[a-zA-Z-0-9-:\/]*$Required: No
- superuserParameters
-
Configuration information for the superuser.
Type: SuperuserParameters object
Required: No
-
Add tags to your FinSpace environment.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[a-zA-Z+-=._:/]+$Value Length Constraints: Minimum length of 1. Maximum length of 256.
Value Pattern:
^[a-zA-Z0-9+-=._:@ ]+$Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"environmentArn": "string",
"environmentId": "string",
"environmentUrl": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- environmentArn
-
The Amazon Resource Name (ARN) of the FinSpace environment that you created.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\d+:environment/[0-9A-Za-z_-]{1,128}$ - environmentId
-
The unique identifier for FinSpace environment that you created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 26.
Pattern:
^[a-zA-Z0-9]{1,26}$ - environmentUrl
-
The sign-in URL for the web application of the FinSpace environment you created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern:
^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- LimitExceededException
-
A service limit or quota is exceeded.
HTTP Status Code: 400
- ServiceQuotaExceededException
-
You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.
HTTP Status Code: 402
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
