UpdateEnvironment - Amazon FinSpace

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 will not be affected. For more information, review the FAQ or contact AWS Support to assist with your transition.


Update your FinSpace environment.

Request Syntax

PUT /environment/environmentId HTTP/1.1 Content-type: application/json { "description": "string", "federationMode": "string", "federationParameters": { "applicationCallBackURL": "string", "attributeMap": { "string" : "string" }, "federationProviderName": "string", "federationURN": "string", "samlMetadataDocument": "string", "samlMetadataURL": "string" }, "name": "string" }

URI Request Parameters

The request uses the following URI parameters.


The identifier of the FinSpace environment.

Length Constraints: Minimum length of 1. Maximum length of 26.

Pattern: ^[a-zA-Z0-9]{1,26}$

Required: Yes

Request Body

The request accepts the following data in JSON format.


The description of the environment.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: ^[a-zA-Z0-9. ]{1,1000}$

Required: No


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


Required: No


Configuration information when authentication mode is FEDERATED.

Type: FederationParameters object

Required: No


The name of the environment.

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: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "environment": { "awsAccountId": "string", "dedicatedServiceAccountId": "string", "description": "string", "environmentArn": "string", "environmentId": "string", "environmentUrl": "string", "federationMode": "string", "federationParameters": { "applicationCallBackURL": "string", "attributeMap": { "string" : "string" }, "federationProviderName": "string", "federationURN": "string", "samlMetadataDocument": "string", "samlMetadataURL": "string" }, "kmsKeyId": "string", "name": "string", "sageMakerStudioDomainUrl": "string", "status": "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.


Returns the FinSpace environment object.

Type: Environment object


For information about the errors that are common to all actions, see Common Errors.


You do not have sufficient access to perform this action.

HTTP Status Code: 403


The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500


One or more resources can't be found.

HTTP Status Code: 404


The request was denied due to request throttling.

HTTP Status Code: 429


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: