Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateEnvironment

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.

environmentId

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.

description

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

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

Required: No

federationParameters

Configuration information when authentication mode is FEDERATED.

Type: FederationParameters object

Required: No

name

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.

environment

Returns the FinSpace environment object.

Type: Environment object

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

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

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