environment (p. 22)
Returns the FinSpace environment object.
Type: Environment (p. 25) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 30).
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: 400 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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
Data Types
The following data types are supported:
Data Types
• Environment (p. 25)
• FederationParameters (p. 28)
• SuperuserParameters (p. 30)
Environment
Environment
Represents an FinSpace environment.
Contents
NoteIn 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
Environment
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 (p. 28) 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.
Environment
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:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
FederationParameters
FederationParameters
Configuration information when authentication mode is FEDERATED.
Contents
Note
In the following list, the required parameters are described first.
applicationCallBackURL
The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: ^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]
Required: No attributeMap
SAML attribute name and value. The name must always be Email and the value should be set to the attribute definition in which user email is set. For example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 32.
Key Pattern: .*
Value Length Constraints: Minimum length of 1. Maximum length of 1000.
Value Pattern: ^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]
Required: No
federationProviderName
Name of the identity provider (IdP).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern: [^_\p{Z}][\p{L}\p{M}\p{S}\p{N}\p{P}][^_\p{Z}]+
Required: No federationURN
The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[A-Za-z0-9._\-:\/#\+]+$
FederationParameters
Required: No
samlMetadataDocument
SAML 2.0 Metadata document from identity provider (IdP).
Type: String
Length Constraints: Minimum length of 1000. Maximum length of 10000000.
Pattern: .*
Required: No samlMetadataURL
Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: ^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
SuperuserParameters
SuperuserParameters
Configuration information for the superuser.
Contents
Note
In the following list, the required parameters are described first.
emailAddress
The email address of the superuser.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [A-Z0-9a-z._%+-]+@[A-Za-z0-9.-]+[.]+[A-Za-z]+
Required: Yes firstName
The first name of the superuser.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern: ^[a-zA-Z0-9]{1,50}$
Required: Yes lastName
The last name of the superuser.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern: ^[a-zA-Z0-9]{1,50}$
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3