Environment -

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

Required: 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 | SUSPENDED

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: