End of support notice: On October 7, 2026, AWS will end support for Amazon FinSpace. After October 7, 2026, you will no longer be able to access the FinSpace console or FinSpace resources. For more information, see Amazon FinSpace end of support.
After careful consideration, we decided to end support for Amazon FinSpace, effective October 7, 2026. Amazon FinSpace will no longer accept new customers beginning October 7, 2025. As an existing customer with an Amazon FinSpace environment created before October 7, 2025, you can continue to use the service as normal. After October 7, 2026, you will no longer be able to use Amazon FinSpace. For more information, see Amazon FinSpace end of support.
Environment
Represents an FinSpace environment.
Contents
Note
In the following list, the required parameters are described first.
- awsAccountId
-
The ID of the AWS account in which the FinSpace environment is created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 26.
Pattern:
^[a-zA-Z0-9]{1,26}$Required: No
- dedicatedServiceAccountId
-
The AWS account ID of the dedicated service account associated with your FinSpace environment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 26.
Pattern:
^[a-zA-Z0-9]{1,26}$Required: No
- description
-
The description of the FinSpace environment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern:
^[a-zA-Z0-9. ]{1,1000}$Required: No
- environmentArn
-
The Amazon Resource Name (ARN) of your FinSpace environment.
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}$Required: No
- environmentId
-
The identifier of the FinSpace environment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 26.
Pattern:
^[a-zA-Z0-9]{1,26}$Required: No
- environmentUrl
-
The sign-in URL for the web application of your FinSpace environment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern:
^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]Required: No
- federationMode
-
The authentication mode for the 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 used to encrypt in the FinSpace environment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern:
^[a-zA-Z-0-9-:\/]*$Required: No
- name
-
The name of the FinSpace 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
- sageMakerStudioDomainUrl
-
The URL of the integrated FinSpace notebook environment in your web application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern:
^[a-zA-Z-0-9-:\/.]*$Required: No
- status
-
The current status of creation of the FinSpace environment.
Type: String
Valid Values:
CREATE_REQUESTED | CREATING | CREATED | DELETE_REQUESTED | DELETING | DELETED | FAILED_CREATION | RETRY_DELETION | FAILED_DELETION | UPDATE_NETWORK_REQUESTED | UPDATING_NETWORK | FAILED_UPDATING_NETWORK | SUSPENDEDRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
